| GET | /api/C2BAccessoryListing |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeAccessories | query | bool? | No | Defaults to True |
| IncludeDeliveryOptions | query | bool? | No | Defaults to False |
| IncludeMaintenanceOptions | query | bool? | No | Defaults to False |
| InstrumentId | query | long? | No | If passed, only accessories for the given instrument are returned |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| 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 |
|---|---|---|---|---|
| Districts | form | List<C2BDistrictGeneric> | No | |
| TeacherTableExists | form | bool | 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 |
|---|---|---|---|---|
| DistrictName | form | string | No | |
| SchoolCount | form | int | No | |
| TeacherCount | form | int | No | |
| Topic | form | string | No | |
| Id | form | long | 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/C2BAccessoryListing HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<C2BGetDistrictInfoResponse 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>
<Districts xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:C2BDistrictGeneric i:nil="true" />
</Districts>
<TeacherTableExists>false</TeacherTableExists>
</C2BGetDistrictInfoResponse>