AIM Web Services

SearchContactManagementRequest

SearchContactManagement web service.

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

import Foundation
import ServiceStack

/**
* SearchContactManagement web service.
*/
// @DataContract
public class SearchContactManagementRequest : BaseSecureRequest
{
    // @DataMember
    public var formattedNotes:Bool?

    /**
    * 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 var ref:String

    // @DataMember
    public var acct:Int?

    // @DataMember
    public var dateFrom:Date?

    // @DataMember
    public var dateTo:Date?

    // @DataMember
    public var includeClosed:Bool?

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

    // @DataMember
    public var actionId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case formattedNotes
        case ref
        case acct
        case dateFrom
        case dateTo
        case includeClosed
        case searchString
        case actionId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        formattedNotes = try container.decodeIfPresent(Bool.self, forKey: .formattedNotes)
        ref = try container.decodeIfPresent(String.self, forKey: .ref)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        dateFrom = try container.decodeIfPresent(Date.self, forKey: .dateFrom)
        dateTo = try container.decodeIfPresent(Date.self, forKey: .dateTo)
        includeClosed = try container.decodeIfPresent(Bool.self, forKey: .includeClosed)
        searchString = try container.decodeIfPresent(String.self, forKey: .searchString)
        actionId = try container.decodeIfPresent(Int.self, forKey: .actionId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if formattedNotes != nil { try container.encode(formattedNotes, forKey: .formattedNotes) }
        if ref != nil { try container.encode(ref, forKey: .ref) }
        if acct != nil { try container.encode(acct, forKey: .acct) }
        if dateFrom != nil { try container.encode(dateFrom, forKey: .dateFrom) }
        if dateTo != nil { try container.encode(dateTo, forKey: .dateTo) }
        if includeClosed != nil { try container.encode(includeClosed, forKey: .includeClosed) }
        if searchString != nil { try container.encode(searchString, forKey: .searchString) }
        if actionId != nil { try container.encode(actionId, forKey: .actionId) }
    }
}

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

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

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

    required public init(){}
}

// @DataContract
public class SearchContactManagementResponse : BaseResponse
{
    // @DataMember
    public var contactManagementRecords:[ContactManagementRecord] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case contactManagementRecords
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        contactManagementRecords = try container.decodeIfPresent([ContactManagementRecord].self, forKey: .contactManagementRecords) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if contactManagementRecords.count > 0 { try container.encode(contactManagementRecords, forKey: .contactManagementRecords) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class ContactManagementRecord : Codable
{
    // @DataMember
    public var ref:String

    // @DataMember
    public var dateTime:Date

    // @DataMember
    public var contact:String

    // @DataMember
    public var cusAcct:Int

    // @DataMember
    public var actionId:Int

    // @DataMember
    public var status:String

    // @DataMember
    public var actionDate:Date?

    // @DataMember
    public var popUp:Bool

    // @DataMember
    public var topicId:Int?

    // @DataMember
    public var topic:String

    // @DataMember
    public var closed:Bool

    // @DataMember
    public var closedDate:Date?

    // @DataMember
    public var colorValue:Int

    // @DataMember
    public var lanId:String

    // @DataMember
    public var formattedNotes:Bool

    // @DataMember
    public var note1:String

    // @DataMember
    public var note2:String

    // @DataMember
    public var note3:String

    // @DataMember
    public var attributes:[AttributeValuePair] = []

    required public init(){}
}

// @DataContract
public class AttributeValuePair : Codable
{
    // @DataMember
    public var name:String

    // @DataMember
    public var value:String

    required public init(){}
}

Swift 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>