| POST, GET | /api/SearchContactManagement |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/** @type {string} */
OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Token;
/** @type {string} */
DeviceId;
/** @type {string} */
AppId;
}
export class BaseResponseResult {
/** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StatusCode;
/** @type {string} */
Login;
/** @type {string} */
ErrorCode;
/** @type {string} */
ErrorDisplayText;
/** @type {string} */
ErrorMessage;
/** @type {string} */
DomainName;
/** @type {string} */
IpAddress;
}
export class BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BaseResponseResult} */
Status;
}
export class AttributeValuePair {
/** @param {{Name?:string,Value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Value;
}
export class ContactManagementRecord {
/** @param {{Ref?:string,DateTime?:string,Contact?:string,CusAcct?:number,ActionId?:number,Status?:string,ActionDate?:string,PopUp?:boolean,TopicId?:number,Topic?:string,Closed?:boolean,ClosedDate?:string,ColorValue?:number,LanId?:string,FormattedNotes?:boolean,Note1?:string,Note2?:string,Note3?:string,Attributes?:AttributeValuePair[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Ref;
/** @type {string} */
DateTime;
/** @type {string} */
Contact;
/** @type {number} */
CusAcct;
/** @type {number} */
ActionId;
/** @type {string} */
Status;
/** @type {?string} */
ActionDate;
/** @type {boolean} */
PopUp;
/** @type {?number} */
TopicId;
/** @type {string} */
Topic;
/** @type {boolean} */
Closed;
/** @type {?string} */
ClosedDate;
/** @type {number} */
ColorValue;
/** @type {string} */
LanId;
/** @type {boolean} */
FormattedNotes;
/** @type {string} */
Note1;
/** @type {string} */
Note2;
/** @type {string} */
Note3;
/** @type {AttributeValuePair[]} */
Attributes;
}
export class SearchContactManagementResponse extends BaseResponse {
/** @param {{ContactManagementRecords?:ContactManagementRecord[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ContactManagementRecord[]} */
ContactManagementRecords;
}
export class SearchContactManagementRequest extends BaseSecureRequest {
/** @param {{FormattedNotes?:boolean,Ref?:string,Acct?:number,DateFrom?:string,DateTo?:string,IncludeClosed?:boolean,SearchString?:string,ActionId?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?boolean} */
FormattedNotes;
/**
* @type {string}
* @description If sent, all other search parameters will be ignored. */
Ref;
/** @type {?number} */
Acct;
/** @type {?string} */
DateFrom;
/** @type {?string} */
DateTo;
/** @type {?boolean} */
IncludeClosed;
/** @type {string} */
SearchString;
/** @type {?number} */
ActionId;
}
JavaScript SearchContactManagementRequest DTOs
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.
POST /api/SearchContactManagement HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SearchContactManagementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<Acct>0</Acct>
<ActionId>0</ActionId>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<FormattedNotes>false</FormattedNotes>
<IncludeClosed>false</IncludeClosed>
<Ref>String</Ref>
<SearchString>String</SearchString>
</SearchContactManagementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchContactManagementResponse 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>
<ContactManagementRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:ContactManagementRecord>
<d2p1:ActionDate>0001-01-01T00:00:00</d2p1:ActionDate>
<d2p1:ActionId>0</d2p1:ActionId>
<d2p1:Attributes>
<d2p1:AttributeValuePair>
<d2p1:Name>String</d2p1:Name>
<d2p1:Value>String</d2p1:Value>
</d2p1:AttributeValuePair>
</d2p1:Attributes>
<d2p1:Closed>false</d2p1:Closed>
<d2p1:ClosedDate>0001-01-01T00:00:00</d2p1:ClosedDate>
<d2p1:ColorValue>0</d2p1:ColorValue>
<d2p1:Contact>String</d2p1:Contact>
<d2p1:CusAcct>0</d2p1:CusAcct>
<d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
<d2p1:FormattedNotes>false</d2p1:FormattedNotes>
<d2p1:LanId>String</d2p1:LanId>
<d2p1:Note1>String</d2p1:Note1>
<d2p1:Note2>String</d2p1:Note2>
<d2p1:Note3>String</d2p1:Note3>
<d2p1:PopUp>false</d2p1:PopUp>
<d2p1:Ref>String</d2p1:Ref>
<d2p1:Status>String</d2p1:Status>
<d2p1:Topic>String</d2p1:Topic>
<d2p1:TopicId>0</d2p1:TopicId>
</d2p1:ContactManagementRecord>
</ContactManagementRecords>
</SearchContactManagementResponse>