| POST | /api/EditContactRecord |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RefNumber | body | string | No | |
| Contact | body | string | No | |
| CustomerAcct | body | int? | No | |
| ActionId | body | long? | No | |
| ActionDate | body | DateTime? | No | |
| PopUp | body | bool? | No | |
| TopicId | body | long? | No | |
| Closed | body | bool? | No | |
| ClosedDate | body | DateTime? | No | |
| ColorValue | body | int? | No | |
| LanID | body | string | No | |
| FormattedNotes | body | bool | No | |
| AppendNotes | body | bool | No | |
| Note1 | body | string | No | |
| Note2 | body | string | No | |
| Note3 | body | string | No | |
| Attributes | body | List<AttributeValuePair> | No | |
| NewAttachments | body | List<FileAttachment> | 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 |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileName | form | string | No | |
| Base64Contents | 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/EditContactRecord HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RefNumber":"String","Contact":"String","CustomerAcct":0,"ActionId":0,"ActionDate":"0001-01-01T00:00:00.0000000","PopUp":false,"TopicId":0,"Closed":false,"ClosedDate":"0001-01-01T00:00:00.0000000","ColorValue":0,"LanID":"String","FormattedNotes":false,"AppendNotes":false,"Note1":"String","Note2":"String","Note3":"String","Attributes":[{"Name":"String","Value":"String"}],"NewAttachments":[{"FileName":"String","Base64Contents":"String"}],"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}