| POST, GET | /api/C2BGetTeacherInfo |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlanCode | query | string | No | If sent, only teachers associated with the sent plan code will be returned. |
| SchoolId | query | integer | No | If sent, only teachers associated with the sent school will be returned. |
| TeacherId | query | integer | No | If sent, only info for the sent teacher will be returned. |
| RinPk | query | integer | No | ID of the Instrument record. Optional. |
| RequestType | query | string | No | Optional Request Type. Valid values are Contract and Shipping. |
| 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 |
|---|---|---|---|---|
| Teachers | form | List<C2BTeacherGeneric> | No | |
| PlanCode | form | string | 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 |
|---|---|---|---|---|
| TeacherName | form | string | No | |
| SchoolName | form | string | No | |
| DistrictName | form | string | No | |
| Topic | form | string | No | |
| Id | form | long | No | |
| DeliveryInfo | form | C2BDeliveryInfo | No | |
| AIMSchoolId | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstDelivery | form | DateTime | No | |
| DeliveryTime | form | DateTime | No | |
| DeliveryThreshold | form | int | No | |
| SundayDelivery | form | bool | No | |
| MondayDelivery | form | bool | No | |
| TuesdayDelivery | form | bool | No | |
| WednesdayDelivery | form | bool | No | |
| ThursdayDelivery | form | bool | No | |
| FridayDelivery | form | bool | No | |
| SaturdayDelivery | form | bool | 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.
POST /api/C2BGetTeacherInfo HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<C2BGetTeacherInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<OAuthToken>String</OAuthToken>
<PlanCode>String</PlanCode>
<RequestType>String</RequestType>
<RinPk>0</RinPk>
<SchoolId>0</SchoolId>
<TeacherId>0</TeacherId>
</C2BGetTeacherInfoRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<C2BGetTeacherInfoResponse 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>
<PlanCode>String</PlanCode>
<Teachers xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:C2BTeacherGeneric i:nil="true" />
</Teachers>
</C2BGetTeacherInfoResponse>