POST, GET | /api/C2BGetSchoolInfo |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PlanCode | query | string | No | If sent, only schools associated with the sent plan code will be returned. |
DistrictId | query | integer | No | If sent, only schools associated with the sent district 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 | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Schools | form | List<C2BSchoolGeneric> | 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 |
---|---|---|---|---|
SchoolName | form | string | No | |
DistrictName | form | string | No | |
TeacherCount | form | int | 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/C2BGetSchoolInfo HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<C2BGetSchoolInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<DistrictId>0</DistrictId>
<PlanCode>String</PlanCode>
<RequestType>String</RequestType>
<RinPk>0</RinPk>
</C2BGetSchoolInfoRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <C2BGetSchoolInfoResponse 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> <Schools xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM"> <d2p1:C2BSchoolGeneric i:nil="true" /> </Schools> </C2BGetSchoolInfoResponse>