AIM Web Services

<back to all web services

SearchContactManagementRequest

SearchContactManagement web service.

The following routes are available for this service:
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 .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"}}