| 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 .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/ServiceStatus HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ServiceStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<NewLocator>String</NewLocator>
<NewLocatorId>0</NewLocatorId>
<NewMasterTicket>String</NewMasterTicket>
<NewStatus>String</NewStatus>
<NewStatusId>0</NewStatusId>
<Tickets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Tickets>
</ServiceStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ServiceStatusResponse 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>
<Statuses>
<ServiceStatusResponse.ServiceStatus>
<Code>String</Code>
<Description>String</Description>
<Id>0</Id>
<Status>String</Status>
</ServiceStatusResponse.ServiceStatus>
</Statuses>
</ServiceStatusResponse>