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.*


/**
* SearchContactManagement web service.
*/
@DataContract
open class SearchContactManagementRequest : BaseSecureRequest()
{
    @DataMember
    var FormattedNotes:Boolean? = 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")
    var Ref:String? = null

    @DataMember
    var Acct:Int? = null

    @DataMember
    var DateFrom:Date? = null

    @DataMember
    var DateTo:Date? = null

    @DataMember
    var IncludeClosed:Boolean? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="SearchString", ParameterType="query")
    var SearchString:String? = null

    @DataMember
    var ActionId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class SearchContactManagementResponse : BaseResponse()
{
    @DataMember
    var ContactManagementRecords:ArrayList<ContactManagementRecord> = ArrayList<ContactManagementRecord>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class ContactManagementRecord
{
    @DataMember
    var Ref:String? = null

    @DataMember
    var DateTime:Date? = null

    @DataMember
    var Contact:String? = null

    @DataMember
    var CusAcct:Int? = null

    @DataMember
    var ActionId:Long? = null

    @DataMember
    var Status:String? = null

    @DataMember
    var ActionDate:Date? = null

    @DataMember
    var PopUp:Boolean? = null

    @DataMember
    var TopicId:Long? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Closed:Boolean? = null

    @DataMember
    var ClosedDate:Date? = null

    @DataMember
    var ColorValue:Int? = null

    @DataMember
    var LanId:String? = null

    @DataMember
    var FormattedNotes:Boolean? = null

    @DataMember
    var Note1:String? = null

    @DataMember
    var Note2:String? = null

    @DataMember
    var Note3:String? = null

    @DataMember
    var Attributes:ArrayList<AttributeValuePair> = ArrayList<AttributeValuePair>()
}

@DataContract
open class AttributeValuePair
{
    @DataMember
    var Name:String? = null

    @DataMember
    var Value:String? = null
}

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