AIM Web Services

<back to all web services

UpdateCustomerRequest

UpdateCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/UpdateCustomer
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    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

        <DataContract(Name:="FormInput")>
        Public Partial Class FormInput
            '''<Summary>
            '''Field Name of the Input Field
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Field Name of the Input Field", IsRequired:=true, Name:="Key", ParameterType:="query")>
            Public Overridable Property Key As String

            '''<Summary>
            '''Value of the Input Field.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Value of the Input Field.", IsRequired:=true, Name:="Value", ParameterType:="query")>
            Public Overridable Property Value As String

            '''<Summary>
            '''Whether or not the field is encryped with the C2B encryption key.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="Whether or not the field is encryped with the C2B encryption key.", IsRequired:=true, Name:="Encrypted", ParameterType:="query")>
            Public Overridable Property Encrypted As Boolean
        End Class

        '''<Summary>
        '''UpdateCustomerRequires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class UpdateCustomerRequest
            Inherits BaseSecureRequest
            Public Sub New()
                FormInputList = New List(Of FormInput)
            End Sub

            '''<Summary>
            '''Customer Acct #
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Customer Acct #", Format:="int32", IsRequired:=true, Name:="Acct", ParameterType:="query")>
            Public Overridable Property Acct As Integer

            '''<Summary>
            '''Location ID
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Location ID", Format:="int64", Name:="LocationId", ParameterType:="query")>
            Public Overridable Property LocationId As Nullable(Of Long)

            '''<Summary>
            '''Customer Default Id
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Customer Default Id", Format:="int64", Name:="CustomerDefaultId", ParameterType:="query")>
            Public Overridable Property CustomerDefaultId As Nullable(Of Long)

            '''<Summary>
            '''Tax Authority Id
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Tax Authority Id", Format:="int64", Name:="TaxAuthorityId", ParameterType:="query")>
            Public Overridable Property TaxAuthorityId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Attn As String

            <DataMember>
            Public Overridable Property Address1 As String

            <DataMember>
            Public Overridable Property Address2 As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property State As String

            <DataMember>
            Public Overridable Property Zip As String

            <DataMember>
            Public Overridable Property Country As String

            <DataMember>
            Public Overridable Property HomePhone As String

            <DataMember>
            Public Overridable Property WorkPhone As String

            <DataMember>
            Public Overridable Property CellPhone As String

            <DataMember>
            Public Overridable Property Employer As String

            <DataMember>
            Public Overridable Property SS As String

            <DataMember>
            Public Overridable Property Email As String

            '''<Summary>
            '''Email Method. Set this to Word, PDF, HTML, or None
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Email Method. Set this to Word, PDF, HTML, or None", Name:="EmailMethod", ParameterType:="query")>
            Public Overridable Property EmailMethod As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property DriversLicenseInfo As LicenseInfo

            '''<Summary>
            '''If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="bool", Description:="If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.", Name:="RefreshCustomerDefaults", ParameterType:="query")>
            Public Overridable Property RefreshCustomerDefaults As Boolean

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="array", Description:="", Name:="FormInputList", ParameterType:="query")>
            Public Overridable Property FormInputList As List(Of FormInput)
        End Class

        <DataContract>
        Public Partial Class UpdateCustomerResponse
            Inherits BaseResponse
        End Class
    End Namespace
End Namespace

VB.NET UpdateCustomerRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/UpdateCustomer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Acct":0,"LocationId":0,"CustomerDefaultId":0,"TaxAuthorityId":0,"Name":"String","Attn":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","HomePhone":"String","WorkPhone":"String","CellPhone":"String","Employer":"String","SS":"String","Email":"String","EmailMethod":"String","Notes":"String","DriversLicenseInfo":{"Number":"String","Height":"String","Weight":"String","Hair":"String","Eyes":"String","Expiration":"String","Birthday":"String","Ethnicity":"String","Gender":"String","State":"String"},"RefreshCustomerDefaults":false,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}