| 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 | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSchedulingTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<Types>
<GetSchedulingTypesResponse.TypeInfo>
<Desc>String</Desc>
<GroupingDesc>String</GroupingDesc>
<GroupingId>0</GroupingId>
<Id>0</Id>
<Length>0</Length>
<MembershipType>String</MembershipType>
<Rate>0</Rate>
<RecurranceType>String</RecurranceType>
<Topic>String</Topic>
</GetSchedulingTypesResponse.TypeInfo>
</Types>
</GetSchedulingTypesResponse>