| GET | /api/GetSchoolList |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DistrictId | query | integer | No | District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned. |
| 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 |
|---|---|---|---|---|
| Schools | form | List<SchoolGeneric> | 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 | |
| SchoolName | form | string | No | |
| District | form | string | No | |
| Address | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Phone | form | string | No | |
| TaxAuth | form | string | No | |
| DeliveryInfo | form | C2BDeliveryInfo | 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 .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/GetSchoolList HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Schools":[{"Id":0,"SchoolName":"String","District":"String","Address":"String","City":"String","State":"String","Zip":"String","Phone":"String","TaxAuth":"String","DeliveryInfo":{"DeliveryThreshold":0,"SundayDelivery":false,"MondayDelivery":false,"TuesdayDelivery":false,"WednesdayDelivery":false,"ThursdayDelivery":false,"FridayDelivery":false,"SaturdayDelivery":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}