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 .xml suffix or ?format=xml

HTTP + 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>