AIM Web Services

SearchContactManagementRequest

SearchContactManagement web service.

The following routes are available for this service:
POST, GET	/api/SearchContactManagement

**SearchContactManagementRequest** Parameters:
Name	Parameter	Data Type	Required	Description
FormattedNotes	body	bool?	No
Ref	query	string	No	If sent, all other search parameters will be ignored.
Acct	body	int?	No
DateFrom	body	DateTime?	No
DateTo	body	DateTime?	No
IncludeClosed	body	bool?	No
SearchString	query	string	No
ActionId	body	long?	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**SearchContactManagementResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactManagementRecords	form	List<ContactManagementRecord>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
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

**ContactManagementRecord** Parameters:
Name	Parameter	Data Type	Required
Ref	form	string	No
DateTime	form	DateTime	No
Contact	form	string	No
CusAcct	form	int	No
ActionId	form	long	No
Status	form	string	No
ActionDate	form	DateTime?	No
PopUp	form	bool	No
TopicId	form	long?	No
Topic	form	string	No
Closed	form	bool	No
ClosedDate	form	DateTime?	No
ColorValue	form	int	No
LanId	form	string	No
FormattedNotes	form	bool	No
Note1	form	string	No
Note2	form	string	No
Note3	form	string	No
Attributes	form	List<AttributeValuePair>	No

**AttributeValuePair** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/SearchContactManagement HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FormattedNotes":false,"Ref":"String","Acct":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeClosed":false,"SearchString":"String","ActionId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ContactManagementRecords":[{"Ref":"String","Contact":"String","CusAcct":0,"ActionId":0,"Status":"String","ActionDate":"0001-01-01T00:00:00.0000000","PopUp":false,"TopicId":0,"Topic":"String","Closed":false,"ClosedDate":"0001-01-01T00:00:00.0000000","ColorValue":0,"LanId":"String","FormattedNotes":false,"Note1":"String","Note2":"String","Note3":"String","Attributes":[{"Name":"String","Value":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}