| POST | /api/PostServiceTicket |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RefNumber | query | string | No | Online reference number of this appointment |
| SerialNumber | query | string | No | Serial number of the item to be serviced |
| CustomerAcct | query | integer | No | The AIM customer account # of the customer. Optional. |
| CustomerInfo | query | object | No | Customer Information |
| FormInputList | query | array | No | Additional Customer or Appointment info |
| CcInfo | query | object | No | Credit Card info of the customer for this appointment |
| Notes | query | string | No | Notes on this appointment |
| VoiceRecording | body | string | No | |
| ItemDescription | query | string | No | Description of the item to be serviced |
| 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 |
|---|---|---|---|---|
| WebId | body | integer | No | The WebId of the customer. Optional. |
| Name | body | string | Yes | Name of the customer. |
| Addr1 | body | string | No | Address line 1 of the customer |
| Addr2 | body | string | No | Address line 2 of the customer |
| City | body | string | No | City of the customer |
| St | body | string | No | State/Province of the customer |
| Zip | body | string | No | Zip code of the customer |
| Country | body | string | No | Country of the customer |
| Phone | body | string | No | Phone number of the customer |
| body | string | Yes | Email address of the customer. Required. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | body | string | Yes | Field name of the Input Field. If linking to an Attribute, this should match the Tag value. |
| Value | body | string | Yes | Value of the Input Field. |
| Encrypted | body | boolean | No | Whether or not the field is encryped with the C2B encryption key. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TokenStr | body | string | Yes | Token returned from processor |
| CardType | body | string | Yes | Card Type (VISA, MCARD, AMEX, DSCVR) |
| LastFour | body | string | Yes | Last four of the card |
| Expiration | body | string | No | Expiration Date of the Card. (MM/YY) |
| ReasonOnFile | body | string | No | Reason the card is on file. |
| TokenPk | body | integer | No | ID of the existing Token Record in AIM, if applicable |
| Primary | body | boolean | No | Is this the customer's primary card? Defaults to false. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WebRef | form | string | 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 |
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/PostServiceTicket HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RefNumber":"String","SerialNumber":"String","CustomerAcct":0,"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"Notes":"String","VoiceRecording":"String","ItemDescription":"String","Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"WebRef":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}