| GET | /api/ServiceTicketFullDetails |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Acct | query | int? | No | |
| RefNumber | query | string | No | |
| ChangedDate | query | DateTime? | 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 |
|---|---|---|---|---|
| Tickets | form | List<TicketInfo> | 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 |
|---|---|---|---|---|
| Terms | form | int | No | |
| PoNumber | form | string | No | |
| ReturnAuthorizationNumber | form | string | No | |
| Status | form | string | No | |
| ApprovedAmount | form | decimal | No | |
| TotalDue | form | decimal | No | |
| Subtotal | form | decimal | No | |
| Tax1 | form | decimal | No | |
| Tax2 | form | decimal | No | |
| ApprovedDate | form | DateTime | No | |
| BilledDate | form | DateTime | No | |
| Contact | form | string | No | |
| Category | form | int | No | |
| Services | form | List<ServiceInfo> | No | |
| CategoryDescription | form | string | No | |
| SubCategory | form | int | No | |
| SubCategoryDescription | form | string | No | |
| Item | form | string | No | |
| ItemDescription | form | string | No | |
| Manufacturer | form | string | No | |
| Notes | form | string | No | |
| Timestamp | form | DateTime | No | |
| SoldToCustomerAcct | form | int | No | |
| BillToCustomerAcct | form | int | No | |
| Model | form | string | No | |
| StLoc | form | string | No | |
| TaxLoc | form | string | No | |
| RefNumber | form | string | No | |
| MasterNumber | form | string | No | |
| Invoiced | form | bool | No | |
| Deposits | form | List<DepositInfo> | No | |
| SoldToCustomerName | form | string | No | |
| BillToCustomerName | form | string | No | |
| ShipToName | form | string | No | |
| ShipToId | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Parts | form | List<PartInfo> | No | |
| Description | form | string | No | |
| Quantity | form | decimal | No | |
| Rate | form | decimal | No | |
| Discount | form | decimal | No | |
| Total | form | decimal | No | |
| Time | form | decimal | No | |
| Completed | form | bool | No | |
| CompletedDate | form | DateTime | No | |
| Technician | form | string | No | |
| Notes | form | string | No | |
| Category | form | int | No | |
| CategoryDescription | form | string | No | |
| TimerActive | form | bool | No | |
| TimerStartTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Quantity | form | decimal | No | |
| Price | form | decimal | No | |
| Discount | form | decimal | No | |
| Total | form | decimal | No | |
| Notes | form | string | No | |
| Category | form | int | No | |
| CategoryDescription | form | string | No | |
| Sku | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OriginalAmount | form | decimal | No | |
| Amount | form | decimal | No | |
| RefNumber | 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/ServiceTicketFullDetails HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ServiceTicketFullDetailsResponse 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>
<Tickets>
<TicketInfo>
<ApprovedAmount>0</ApprovedAmount>
<ApprovedDate>0001-01-01T00:00:00</ApprovedDate>
<BillToCustomerAcct>0</BillToCustomerAcct>
<BillToCustomerName>String</BillToCustomerName>
<BilledDate>0001-01-01T00:00:00</BilledDate>
<Category>0</Category>
<CategoryDescription>String</CategoryDescription>
<Contact>String</Contact>
<Deposits>
<DepositInfo>
<Amount>0</Amount>
<OriginalAmount>0</OriginalAmount>
<RefNumber>String</RefNumber>
</DepositInfo>
</Deposits>
<Invoiced>false</Invoiced>
<Item>String</Item>
<ItemDescription>String</ItemDescription>
<Manufacturer>String</Manufacturer>
<MasterNumber>String</MasterNumber>
<Model>String</Model>
<Notes>String</Notes>
<PoNumber>String</PoNumber>
<RefNumber>String</RefNumber>
<ReturnAuthorizationNumber>String</ReturnAuthorizationNumber>
<Services>
<ServiceInfo>
<Category>0</Category>
<CategoryDescription>String</CategoryDescription>
<Completed>false</Completed>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<Description>String</Description>
<Discount>0</Discount>
<Id>0</Id>
<Notes>String</Notes>
<Parts>
<PartInfo>
<Category>0</Category>
<CategoryDescription>String</CategoryDescription>
<Description>String</Description>
<Discount>0</Discount>
<Notes>String</Notes>
<Price>0</Price>
<Quantity>0</Quantity>
<Sku>String</Sku>
<Total>0</Total>
</PartInfo>
</Parts>
<Quantity>0</Quantity>
<Rate>0</Rate>
<Technician>String</Technician>
<Time>0</Time>
<TimerActive>false</TimerActive>
<TimerStartTime>0001-01-01T00:00:00</TimerStartTime>
<Total>0</Total>
</ServiceInfo>
</Services>
<ShipToId>0</ShipToId>
<ShipToName>String</ShipToName>
<SoldToCustomerAcct>0</SoldToCustomerAcct>
<SoldToCustomerName>String</SoldToCustomerName>
<StLoc>String</StLoc>
<Status>String</Status>
<SubCategory>0</SubCategory>
<SubCategoryDescription>String</SubCategoryDescription>
<Subtotal>0</Subtotal>
<Tax1>0</Tax1>
<Tax2>0</Tax2>
<TaxLoc>String</TaxLoc>
<Terms>0</Terms>
<Timestamp>0001-01-01T00:00:00</Timestamp>
<TotalDue>0</TotalDue>
</TicketInfo>
</Tickets>
</ServiceTicketFullDetailsResponse>