AIM Web Services

<back to all web services

SearchContactManagementRequest

SearchContactManagement web service.

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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AttributeValuePair
{
    // @DataMember
    public Name: string;

    // @DataMember
    public Value: string;

    public constructor(init?: Partial<AttributeValuePair>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ContactManagementRecord
{
    // @DataMember
    public Ref: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public Contact: string;

    // @DataMember
    public CusAcct: number;

    // @DataMember
    public ActionId: number;

    // @DataMember
    public Status: string;

    // @DataMember
    public ActionDate?: string;

    // @DataMember
    public PopUp: boolean;

    // @DataMember
    public TopicId?: number;

    // @DataMember
    public Topic: string;

    // @DataMember
    public Closed: boolean;

    // @DataMember
    public ClosedDate?: string;

    // @DataMember
    public ColorValue: number;

    // @DataMember
    public LanId: string;

    // @DataMember
    public FormattedNotes: boolean;

    // @DataMember
    public Note1: string;

    // @DataMember
    public Note2: string;

    // @DataMember
    public Note3: string;

    // @DataMember
    public Attributes: AttributeValuePair[];

    public constructor(init?: Partial<ContactManagementRecord>) { (Object as any).assign(this, init); }
}

// @DataContract
export class SearchContactManagementResponse extends BaseResponse
{
    // @DataMember
    public ContactManagementRecords: ContactManagementRecord[];

    public constructor(init?: Partial<SearchContactManagementResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description SearchContactManagement web service. */
// @DataContract
export class SearchContactManagementRequest extends BaseSecureRequest
{
    // @DataMember
    public FormattedNotes?: boolean;

    /** @description If sent, all other search parameters will be ignored. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, all other search parameters will be ignored.", Name="Ref", ParameterType="query")
    public Ref: string;

    // @DataMember
    public Acct?: number;

    // @DataMember
    public DateFrom?: string;

    // @DataMember
    public DateTo?: string;

    // @DataMember
    public IncludeClosed?: boolean;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="SearchString", ParameterType="query")
    public SearchString: string;

    // @DataMember
    public ActionId?: number;

    public constructor(init?: Partial<SearchContactManagementRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}