AIM Web Services

AddContactRecordRequest

AddContactRecord web service.

The following routes are available for this service:
POST	/api/AddContactRecord

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 FileAttachment
            <DataMember>
            Public Overridable Property FileName As String

            <DataMember>
            Public Overridable Property Base64Contents As String
        End Class
    End Namespace

    Namespace AIM.WebService

        '''<Summary>
        '''AddContactRecord web service.
        '''</Summary>
        <DataContract>
        Public Partial Class AddContactRecordRequest
            Inherits BaseSecureRequest
            Public Sub New()
                Attributes = New List(Of AttributeValuePair)
                Attachments = New List(Of FileAttachment)
            End Sub

            <DataMember>
            Public Overridable Property Contact As String

            <DataMember>
            Public Overridable Property CustomerAcct As Integer

            <DataMember>
            Public Overridable Property ActionId As Long

            <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 Closed As Boolean

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

            <DataMember>
            Public Overridable Property ColorValue As Integer

            <DataMember>
            Public Overridable Property OverrideLanID 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)

            <DataMember>
            Public Overridable Property Attachments As List(Of FileAttachment)
        End Class

        <DataContract>
        Public Partial Class AddContactRecordResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property RefNumber As String
        End Class

        <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
    End Namespace
End Namespace

VB.NET AddContactRecordRequest 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/AddContactRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddContactRecordRequest 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>
  <ActionDate>0001-01-01T00:00:00</ActionDate>
  <ActionId>0</ActionId>
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:FileAttachment>
      <d2p1:Base64Contents>String</d2p1:Base64Contents>
      <d2p1:FileName>String</d2p1:FileName>
    </d2p1:FileAttachment>
  </Attachments>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:AttributeValuePair>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:AttributeValuePair>
  </Attributes>
  <Closed>false</Closed>
  <ClosedDate>0001-01-01T00:00:00</ClosedDate>
  <ColorValue>0</ColorValue>
  <Contact>String</Contact>
  <CustomerAcct>0</CustomerAcct>
  <FormattedNotes>false</FormattedNotes>
  <Note1>String</Note1>
  <Note2>String</Note2>
  <Note3>String</Note3>
  <OverrideLanID>String</OverrideLanID>
  <PopUp>false</PopUp>
  <TopicId>0</TopicId>
</AddContactRecordRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddContactRecordResponse 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>
  <RefNumber>String</RefNumber>
</AddContactRecordResponse>