ClubReady Api

<back to all web services

StaffListRequest

The following routes are available for this service:
GET/staffGet Staff for a location
StaffListRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesStoreId is required
StaffTypequeryintegerNoClubReady AdminTypeId
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
AvailableForSchedulingqueryboolNoRestricts results to staff that are available for scheduling
StaffListRequestDto Parameters:
NameParameterData TypeRequiredDescription
StaffTypeformint?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json