AIM Web Services

SearchContactManagementRequest

SearchContactManagement web service.

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class AttributeValuePair
            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Value As String
        End Class

        <DataContract>
        Public Partial Class ContactManagementRecord
            Public Sub New()
                Attributes = New List(Of AttributeValuePair)
            End Sub

            <DataMember>
            Public Overridable Property Ref As String

            <DataMember>
            Public Overridable Property DateTime As Date

            <DataMember>
            Public Overridable Property Contact As String

            <DataMember>
            Public Overridable Property CusAcct As Integer

            <DataMember>
            Public Overridable Property ActionId As Long

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property ActionDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property PopUp As Boolean

            <DataMember>
            Public Overridable Property TopicId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Topic As String

            <DataMember>
            Public Overridable Property Closed As Boolean

            <DataMember>
            Public Overridable Property ClosedDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property ColorValue As Integer

            <DataMember>
            Public Overridable Property LanId As String

            <DataMember>
            Public Overridable Property FormattedNotes As Boolean

            <DataMember>
            Public Overridable Property Note1 As String

            <DataMember>
            Public Overridable Property Note2 As String

            <DataMember>
            Public Overridable Property Note3 As String

            <DataMember>
            Public Overridable Property Attributes As List(Of AttributeValuePair)
        End Class
    End Namespace

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class BaseRequest
            '''<Summary>
            '''This is your AIM API Key provided by Tri-Tech
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="This is your AIM API Key provided by Tri-Tech", IsRequired:=true, Name:="ApiKey", ParameterType:="header")>
            Public Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''SearchContactManagement web service.
        '''</Summary>
        <DataContract>
        Public Partial Class SearchContactManagementRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property FormattedNotes As Nullable(Of Boolean)

            '''<Summary>
            '''If sent, all other search parameters will be ignored.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="If sent, all other search parameters will be ignored.", Name:="Ref", ParameterType:="query")>
            Public Overridable Property Ref As String

            <DataMember>
            Public Overridable Property Acct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property DateFrom As Nullable(Of Date)

            <DataMember>
            Public Overridable Property DateTo As Nullable(Of Date)

            <DataMember>
            Public Overridable Property IncludeClosed As Nullable(Of Boolean)

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="SearchString", ParameterType:="query")>
            Public Overridable Property SearchString As String

            <DataMember>
            Public Overridable Property ActionId As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class SearchContactManagementResponse
            Inherits BaseResponse
            Public Sub New()
                ContactManagementRecords = New List(Of ContactManagementRecord)
            End Sub

            <DataMember>
            Public Overridable Property ContactManagementRecords As List(Of ContactManagementRecord)
        End Class
    End Namespace
End Namespace

VB.NET 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>