| Required role: | API |
| All Verbs | /api/Query/MembershipType |
|---|
| 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 |
|---|---|---|---|---|
| MembershipTypeId | form | int | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Definition | form | string | No | |
| Schedule | form | ScheduleInstance | No | |
| ScheduleId | form | int | No | |
| Deleted | form | bool | No | |
| Demo | form | bool | No | |
| Public | form | bool | No | |
| SessionsRemaining | form | int? | No | |
| ClassesRemaining | form | int? | No | |
| SortOrder | form | int? | No | |
| Special | form | bool | No | |
| MultiSiteAccess | form | bool | No | |
| MemberLimit | form | int | No | |
| PromotionCode | form | string | No | |
| PromotionStart | form | DateTime? | No | |
| PromotionEnd | form | DateTime? | No | |
| LicensesRemaining | form | int? | No | |
| BookingAccessOnly | form | bool | No | |
| SessionsPeriod | form | int? | No | |
| SessionsFrequency | form | int? | No | |
| StartsOn | form | DateTime? | No | |
| AllowSelectionAfterStartsOn | form | bool | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/MembershipType HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"MembershipTypeId":0,"Name":"String","Description":"String","Definition":"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,"Public":false,"SessionsRemaining":0,"ClassesRemaining":0,"SortOrder":0,"Special":false,"MultiSiteAccess":false,"MemberLimit":0,"PromotionCode":"String","PromotionStart":"0001-01-01T00:00:00.0000000","PromotionEnd":"0001-01-01T00:00:00.0000000","LicensesRemaining":0,"BookingAccessOnly":false,"SessionsPeriod":0,"SessionsFrequency":0,"StartsOn":"0001-01-01T00:00:00.0000000","AllowSelectionAfterStartsOn":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}