| GET | /api/GetServiceEstimates |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UseWebFormatting | query | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceEstimates | form | List<ServiceEstimate> | 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 |
|---|---|---|---|---|
| TicketNumber | form | string | No | |
| EstimatedAmount | form | decimal | No | |
| DateTime | form | DateTime | No | |
| InventoryItem | form | string | No | |
| ServiceDescription | form | string | No | |
| Notes | 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.
GET /api/GetServiceEstimates HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetServiceEstimatesResponse 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>
<ServiceEstimates>
<GetServiceEstimatesResponse.ServiceEstimate>
<DateTime>0001-01-01T00:00:00</DateTime>
<EstimatedAmount>0</EstimatedAmount>
<InventoryItem>String</InventoryItem>
<Notes>String</Notes>
<ServiceDescription>String</ServiceDescription>
<TicketNumber>String</TicketNumber>
</GetServiceEstimatesResponse.ServiceEstimate>
</ServiceEstimates>
</GetServiceEstimatesResponse>