| GET | /api/ScheduledExchanges |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ScheduledDateFrom | query | DateTime? | No | |
| ScheduledDateTo | query | DateTime? | No | |
| DistrictId | query | long? | No | |
| SchoolId | query | long? | No | |
| LocationId | query | long? | No | |
| StatusId | query | long? | No | |
| OptionId | query | long? | No | |
| IncludeProcessed | 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 |
|---|---|---|---|---|
| ScheduledExchanges | form | List<ScheduledExchangesGetInfo> | 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 |
|---|---|---|---|---|
| ExchangeID | form | long | No | |
| 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 | |
| StockNumber | form | string | No | |
| Serial | form | string | No | |
| ReturnOption | form | string | No | |
| ScheduledReturnedRef | form | string | No | |
| Status | form | string | No | |
| History | form | string | No | |
| ExchangeRef | form | long? | No | |
| AutoPayHoldDate | form | DateTime? | No | |
| ExchangedItem | form | string | No | |
| PostingDate | form | DateTime | No | |
| ScheduledDate | form | DateTime | No | |
| NewSku | form | string | No | |
| Notes | form | string | No | |
| Source | form | string | No | |
| Option | form | string | No | |
| Processed | form | bool | No | |
| MobileExchangedStatus | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ScheduledExchanges HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ScheduledExchanges":[{"ExchangeID":0,"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","History":"String","ExchangeRef":0,"AutoPayHoldDate":"0001-01-01T00:00:00.0000000","ExchangedItem":"String","NewSku":"String","Notes":"String","Source":"String","Option":"String","Processed":false,"MobileExchangedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}