<back to all web services
StaffListRequest
The following routes are available for this service:| GET | /staff | Get Staff for a location | |
|---|
StaffListRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| StoreId | query | integer | Yes | StoreId is required |
| StaffType | query | integer | No | ClubReady AdminTypeId |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
| AvailableForScheduling | query | bool | No | Restricts results to staff that are available for scheduling |
StaffListRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| StaffType | form | int? | No | |
ApiDtoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No | |
RestrictedResourceType Enum:| Store | |
| Chain | |
| User | |
| Undefined | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /staff HTTP/1.1
Host: clubready.com
Accept: text/csv