| GET, POST | /api/ServiceStatus |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Tickets | query | List<string> | No | List of Tickets to be updated. Only used for a POST request. |
| NewStatusId | query | long? | No | New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus. |
| NewStatus | query | string | No | New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus. |
| NewLocatorId | query | long? | No | New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator. |
| NewLocator | query | string | No | New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId. |
| NewMasterTicket | query | string | No | New Master Ticket # to be set to the tickets. Only used for a POST request. |
| 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 |
|---|---|---|---|---|
| Statuses | form | List<ServiceStatus> | 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 | |
| Status | form | string | No | |
| Description | form | string | No | |
| Code | form | string | 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.
POST /api/ServiceStatus HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Tickets":["String"],"NewStatusId":0,"NewStatus":"String","NewLocatorId":0,"NewLocator":"String","NewMasterTicket":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Statuses":[{"Id":0,"Status":"String","Description":"String","Code":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}