AIM Web Services

SearchContactManagementRequest

SearchContactManagement web service.

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * SearchContactManagement web service.
    */
    @DataContract
    public static class SearchContactManagementRequest extends BaseSecureRequest
    {
        @DataMember
        public Boolean FormattedNotes = null;

        /**
        * 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 String Ref = null;

        @DataMember
        public Integer Acct = null;

        @DataMember
        public Date DateFrom = null;

        @DataMember
        public Date DateTo = null;

        @DataMember
        public Boolean IncludeClosed = null;

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

        @DataMember
        public Long ActionId = null;
        
        public Boolean isFormattedNotes() { return FormattedNotes; }
        public SearchContactManagementRequest setFormattedNotes(Boolean value) { this.FormattedNotes = value; return this; }
        public String getRef() { return Ref; }
        public SearchContactManagementRequest setRef(String value) { this.Ref = value; return this; }
        public Integer getAcct() { return Acct; }
        public SearchContactManagementRequest setAcct(Integer value) { this.Acct = value; return this; }
        public Date getDateFrom() { return DateFrom; }
        public SearchContactManagementRequest setDateFrom(Date value) { this.DateFrom = value; return this; }
        public Date getDateTo() { return DateTo; }
        public SearchContactManagementRequest setDateTo(Date value) { this.DateTo = value; return this; }
        public Boolean isIncludeClosed() { return IncludeClosed; }
        public SearchContactManagementRequest setIncludeClosed(Boolean value) { this.IncludeClosed = value; return this; }
        public String getSearchString() { return SearchString; }
        public SearchContactManagementRequest setSearchString(String value) { this.SearchString = value; return this; }
        public Long getActionId() { return ActionId; }
        public SearchContactManagementRequest setActionId(Long value) { this.ActionId = value; return this; }
    }

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

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * 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 String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class SearchContactManagementResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ContactManagementRecord> ContactManagementRecords = null;
        
        public ArrayList<ContactManagementRecord> getContactManagementRecords() { return ContactManagementRecords; }
        public SearchContactManagementResponse setContactManagementRecords(ArrayList<ContactManagementRecord> value) { this.ContactManagementRecords = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

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

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

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

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

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class ContactManagementRecord
    {
        @DataMember
        public String Ref = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public String Contact = null;

        @DataMember
        public Integer CusAcct = null;

        @DataMember
        public Long ActionId = null;

        @DataMember
        public String Status = null;

        @DataMember
        public Date ActionDate = null;

        @DataMember
        public Boolean PopUp = null;

        @DataMember
        public Long TopicId = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public Boolean Closed = null;

        @DataMember
        public Date ClosedDate = null;

        @DataMember
        public Integer ColorValue = null;

        @DataMember
        public String LanId = null;

        @DataMember
        public Boolean FormattedNotes = null;

        @DataMember
        public String Note1 = null;

        @DataMember
        public String Note2 = null;

        @DataMember
        public String Note3 = null;

        @DataMember
        public ArrayList<AttributeValuePair> Attributes = null;
        
        public String getRef() { return Ref; }
        public ContactManagementRecord setRef(String value) { this.Ref = value; return this; }
        public Date getDateTime() { return DateTime; }
        public ContactManagementRecord setDateTime(Date value) { this.DateTime = value; return this; }
        public String getContact() { return Contact; }
        public ContactManagementRecord setContact(String value) { this.Contact = value; return this; }
        public Integer getCusAcct() { return CusAcct; }
        public ContactManagementRecord setCusAcct(Integer value) { this.CusAcct = value; return this; }
        public Long getActionId() { return ActionId; }
        public ContactManagementRecord setActionId(Long value) { this.ActionId = value; return this; }
        public String getStatus() { return Status; }
        public ContactManagementRecord setStatus(String value) { this.Status = value; return this; }
        public Date getActionDate() { return ActionDate; }
        public ContactManagementRecord setActionDate(Date value) { this.ActionDate = value; return this; }
        public Boolean isPopUp() { return PopUp; }
        public ContactManagementRecord setPopUp(Boolean value) { this.PopUp = value; return this; }
        public Long getTopicId() { return TopicId; }
        public ContactManagementRecord setTopicId(Long value) { this.TopicId = value; return this; }
        public String getTopic() { return Topic; }
        public ContactManagementRecord setTopic(String value) { this.Topic = value; return this; }
        public Boolean isClosed() { return Closed; }
        public ContactManagementRecord setClosed(Boolean value) { this.Closed = value; return this; }
        public Date getClosedDate() { return ClosedDate; }
        public ContactManagementRecord setClosedDate(Date value) { this.ClosedDate = value; return this; }
        public Integer getColorValue() { return ColorValue; }
        public ContactManagementRecord setColorValue(Integer value) { this.ColorValue = value; return this; }
        public String getLanId() { return LanId; }
        public ContactManagementRecord setLanId(String value) { this.LanId = value; return this; }
        public Boolean isFormattedNotes() { return FormattedNotes; }
        public ContactManagementRecord setFormattedNotes(Boolean value) { this.FormattedNotes = value; return this; }
        public String getNote1() { return Note1; }
        public ContactManagementRecord setNote1(String value) { this.Note1 = value; return this; }
        public String getNote2() { return Note2; }
        public ContactManagementRecord setNote2(String value) { this.Note2 = value; return this; }
        public String getNote3() { return Note3; }
        public ContactManagementRecord setNote3(String value) { this.Note3 = value; return this; }
        public ArrayList<AttributeValuePair> getAttributes() { return Attributes; }
        public ContactManagementRecord setAttributes(ArrayList<AttributeValuePair> value) { this.Attributes = value; return this; }
    }

    @DataContract
    public static class AttributeValuePair
    {
        @DataMember
        public String Name = null;

        @DataMember
        public String Value = null;
        
        public String getName() { return Name; }
        public AttributeValuePair setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public AttributeValuePair setValue(String value) { this.Value = value; return this; }
    }

}

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