AIM Web Services

<back to all web services

EditContactRecordRequest

EditContactRecord web service.

The following routes are available for this service:
POST/api/EditContactRecord
EditContactRecordRequest Parameters:
NameParameterData TypeRequiredDescription
RefNumberbodystringNo
ContactbodystringNo
CustomerAcctbodyint?No
ActionIdbodylong?No
ActionDatebodyDateTime?No
PopUpbodybool?No
TopicIdbodylong?No
Closedbodybool?No
ClosedDatebodyDateTime?No
ColorValuebodyint?No
LanIDbodystringNo
FormattedNotesbodyboolNo
AppendNotesbodyboolNo
Note1bodystringNo
Note2bodystringNo
Note3bodystringNo
AttributesbodyList<AttributeValuePair>No
NewAttachmentsbodyList<FileAttachment>No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
AttributeValuePair Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
FileAttachment Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
Base64ContentsformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

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

HTTP + JSON

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","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"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"}}