| GET | /api/GetSchedulingTypes |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeId | query | integer | No | Type ID to look up. If sent, all other parameters will be ignored. |
| GroupingId | query | integer | No | If sent, only types in the sent grouping will be returned. |
| InstructorId | query | integer | No | If sent, only types taught by the sent instructor will be returned. |
| LocationId | query | integer | No | If sent, only types taught at the sent location will be returned. |
| MembershipType | query | integer | No | If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Types | form | List<TypeInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Desc | form | string | No | |
| Length | form | int | No | |
| Topic | form | string | No | |
| RecurranceType | form | string | No | |
| MembershipType | form | string | No | |
| Rate | form | decimal | No | |
| GroupingId | form | long? | No | |
| GroupingDesc | form | string | 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.
GET /api/GetSchedulingTypes HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Types":[{"Id":0,"Desc":"String","Length":0,"Topic":"String","RecurranceType":"String","MembershipType":"String","Rate":0,"GroupingId":0,"GroupingDesc":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}