Required role: | API |
All Verbs | /api/Query/Facility |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FacilityId | form | int | No | |
Name | form | string | No | |
Description | form | string | No | |
Schedule | form | ScheduleInstance | No | |
ScheduleId | form | int | No | |
Colour | form | string | No | |
Bookable | form | bool | No | |
Deleted | form | bool | No | |
Demo | form | bool | No | |
Group | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ScheduleId | form | int | No | |
Name | form | string | No | |
Description | form | string | No | |
MondayFrom | form | TimeSpan? | No | |
MondayTo | form | TimeSpan? | No | |
TuesdayFrom | form | TimeSpan? | No | |
TuesdayTo | form | TimeSpan? | No | |
WednesdayFrom | form | TimeSpan? | No | |
WednesdayTo | form | TimeSpan? | No | |
ThursdayFrom | form | TimeSpan? | No | |
ThursdayTo | form | TimeSpan? | No | |
FridayFrom | form | TimeSpan? | No | |
FridayTo | form | TimeSpan? | No | |
SaturdayFrom | form | TimeSpan? | No | |
SaturdayTo | form | TimeSpan? | No | |
SundayFrom | form | TimeSpan? | No | |
SundayTo | form | TimeSpan? | No | |
ScheduleType | form | int | No | |
Deleted | form | bool | No | |
Demo | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/Facility HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
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/jsv Content-Length: length { Offset: 0, Total: 0, Results: [ { FacilityId: 0, Name: String, Description: 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, Colour: String, Bookable: False, Deleted: False, Demo: False, Group: String } ], Meta: { String: String }, ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } } }