| GET | /api/ContractScheduledReturns |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateFrom | query | DateTime? | No | |
| DateTo | query | DateTime? | No | |
| DistrictId | query | long? | No | |
| SchoolId | query | long? | No | |
| LocationId | query | long? | No | |
| StatusId | query | long? | No | |
| OptionId | query | long? | No | |
| IncludeReturned | query | bool? | No | |
| LanId | query | string | No |
| 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 |
|---|---|---|---|---|
| Contracts | form | List<ContractScheduledReturnInfo> | 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 |
|---|---|---|---|---|
| Acct | form | int | No | |
| Sub | form | int | No | |
| Name | form | string | No | |
| Address | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| Student | form | string | No | |
| School | form | string | No | |
| District | form | string | No | |
| Item | form | string | No | |
| Employee | form | string | No | |
| ReturnedDate | form | DateTime? | No | |
| ScheduledReturnDate | form | DateTime | No | |
| StockNumber | form | string | No | |
| Serial | form | string | No | |
| ReturnOption | form | string | No | |
| ScheduledReturnedRef | form | string | No | |
| Status | form | string | No | |
| AutoPayHoldDate | form | DateTime? | No | |
| MobileReturnedStatus | 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/ContractScheduledReturns HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Contracts":[{"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","AutoPayHoldDate":"0001-01-01T00:00:00.0000000","MobileReturnedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}