ClubManager.Api

<back to all web services

FindStaff

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Staff
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
StaffInstance Parameters:
NameParameterData TypeRequiredDescription
StaffIdformintNo
NameformstringNo
ScheduleformScheduleInstanceNo
ScheduleIdformint?No
DeletedformboolNo
DemoformboolNo
GroupformstringNo
ProfileformstringNo
FirstAidTrainedformboolNo
DBSCheckformDateTime?No
InsuranceExpiresformDateTime?No
ScheduleInstance Parameters:
NameParameterData TypeRequiredDescription
ScheduleIdformintNo
NameformstringNo
DescriptionformstringNo
MondayFromformTimeSpan?No
MondayToformTimeSpan?No
TuesdayFromformTimeSpan?No
TuesdayToformTimeSpan?No
WednesdayFromformTimeSpan?No
WednesdayToformTimeSpan?No
ThursdayFromformTimeSpan?No
ThursdayToformTimeSpan?No
FridayFromformTimeSpan?No
FridayToformTimeSpan?No
SaturdayFromformTimeSpan?No
SaturdayToformTimeSpan?No
SundayFromformTimeSpan?No
SundayToformTimeSpan?No
ScheduleTypeformintNo
DeletedformboolNo
DemoformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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.

POST /api/Query/Staff HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"StaffId":0,"Name":"String","Schedule":{"ScheduleId":0,"Name":"String","Description":"String","MondayFrom":"PT0S","MondayTo":"PT0S","TuesdayFrom":"PT0S","TuesdayTo":"PT0S","WednesdayFrom":"PT0S","WednesdayTo":"PT0S","ThursdayFrom":"PT0S","ThursdayTo":"PT0S","FridayFrom":"PT0S","FridayTo":"PT0S","SaturdayFrom":"PT0S","SaturdayTo":"PT0S","SundayFrom":"PT0S","SundayTo":"PT0S","ScheduleType":0,"Deleted":false,"Demo":false},"ScheduleId":0,"Deleted":false,"Demo":false,"Group":"String","Profile":"String","FirstAidTrained":false,"DBSCheck":"0001-01-01T00:00:00.0000000","InsuranceExpires":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}