AIM Web Services

<back to all web services

CustomerInfoRequest

CustomerInfo
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/CustomerInfo
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM
Imports AIM.Global.Utils

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class CustomerDefaultInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property ShortDesc As String
        End Class

        <DataContract>
        Public Partial Class CustomerSearchRecord
            Inherits BindableObject
            Public Sub New()
                DependantInfo = New List(Of DependantRecord)
            End Sub

            <DataMember>
            Public Overridable Property Pk As Long

            <DataMember>
            Public Overridable Property Acct As Integer

            <DataMember>
            Public Overridable Property Last As String

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Addr1 As String

            <DataMember>
            Public Overridable Property Addr2 As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property St As String

            <DataMember>
            Public Overridable Property Zip As String

            <DataMember>
            Public Overridable Property Phone As String

            <DataMember>
            Public Overridable Property Email As String

            <DataMember>
            Public Overridable Property OpenInvoices As Boolean

            <DataMember>
            Public Overridable Property RentalActivity As Boolean

            <DataMember>
            Public Overridable Property StLoc As String

            <DataMember>
            Public Overridable Property Hold As Boolean

            <DataMember>
            Public Overridable Property Barcode As String

            <DataMember>
            Public Overridable Property Color As Integer

            <DataMember>
            Public Overridable Property DependantInfo As List(Of DependantRecord)

            <DataMember>
            Public Overridable Property AdditionalDetails As AdditionalDetail

            <DataMember>
            Public Overridable Property MatchedOn As String

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

                <DataMember>
                Public Overridable Property OnlineId As String

                <DataMember>
                Public Overridable Property SchoolDistrict As String

                <DataMember>
                Public Overridable Property School As String

                <DataMember>
                Public Overridable Property Id As Long
            End Class

            <DataContract>
            Public Partial Class AdditionalDetail
                <DataMember>
                Public Overridable Property CreationDate As Date

                <DataMember>
                Public Overridable Property LastModifiedDate As Date

                <DataMember>
                Public Overridable Property Notes As String

                <DataMember>
                Public Overridable Property CustomerDefault As CustomerDefaultInfo

                <DataMember>
                Public Overridable Property TaxAuthority As TaxAuthorityInfo

                <DataMember>
                Public Overridable Property CanCharge As Boolean

                <DataMember>
                Public Overridable Property PopupNotes As String

                <DataMember>
                Public Overridable Property DlNumber As String

                <DataMember>
                Public Overridable Property Phone2 As String

                <DataMember>
                Public Overridable Property Phone3 As String

                <DataMember>
                Public Overridable Property Phone4 As String

                <DataMember>
                Public Overridable Property Location As LocationInfo
            End Class
        End Class

        <DataContract>
        Public Partial Class LocationInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property ShortDesc As String

            <DataMember>
            Public Overridable Property Region As String

            <DataMember>
            Public Overridable Property Latitude As Decimal

            <DataMember>
            Public Overridable Property Longitude As Decimal

            <DataMember>
            Public Overridable Property InStorePickup As String

            <DataMember>
            Public Overridable Property Active As Boolean

            <DataMember>
            Public Overridable Property CashSaleAcct As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class TaxAuthorityInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Desc As String

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

    Namespace AIM.Global.Utils

        <DataContract>
        Public Partial Class BindableObject
        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

        <DataContract>
        Public Partial Class CategoryLevelDiscount
            <DataMember>
            Public Overridable Property Category As Integer

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

            <DataMember>
            Public Overridable Property DiscountType As String

            <DataMember>
            Public Overridable Property DiscountAmount As Decimal
        End Class

        <DataContract>
        Public Partial Class CustomerDiscountInfo
            Public Sub New()
                CategoryLevelDiscounts = New List(Of CategoryLevelDiscount)
            End Sub

            <DataMember>
            Public Overridable Property AccessoryInventory As Decimal

            <DataMember>
            Public Overridable Property SerializedInventory As Decimal

            <DataMember>
            Public Overridable Property ShortTermRental As Decimal

            <DataMember>
            Public Overridable Property NonInventory As Decimal

            <DataMember>
            Public Overridable Property Labor As Decimal

            <DataMember>
            Public Overridable Property MediaInventory As Decimal

            <DataMember>
            Public Overridable Property CategoryLevelDiscounts As List(Of CategoryLevelDiscount)

            <DataMember>
            Public Overridable Property PriceLevel As String
        End Class

        <DataContract>
        Public Partial Class CustomerEmailInfo
            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Email As String

            <DataMember>
            Public Overridable Property Method As String

            <DataMember>
            Public Overridable Property Type As String
        End Class

        '''<Summary>
        '''CustomerInfoRequires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class CustomerInfoRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Acct As Integer
        End Class

        <DataContract>
        Public Partial Class CustomerInfoResponse
            Inherits BaseResponse
            Public Sub New()
                Memberships = New List(Of CustomerMembershipInfo)
                Emails = New List(Of CustomerEmailInfo)
            End Sub

            <DataMember>
            Public Overridable Property Customer As CustomerSearchRecord

            <DataMember>
            Public Overridable Property DiscountInfo As CustomerDiscountInfo

            <DataMember>
            Public Overridable Property Memberships As List(Of CustomerMembershipInfo)

            <DataMember>
            Public Overridable Property Emails As List(Of CustomerEmailInfo)
        End Class

        <DataContract>
        Public Partial Class CustomerMembershipInfo
            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property TeeLevel As Integer

            <DataMember>
            Public Overridable Property WebTeeLevel As Integer

            <DataMember>
            Public Overridable Property StationLevel As Integer
        End Class
    End Namespace
End Namespace

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

GET /api/CustomerInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<CustomerInfoResponse 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>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:Acct>0</d2p1:Acct>
    <d2p1:AdditionalDetails>
      <d2p1:CanCharge>false</d2p1:CanCharge>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:CustomerDefault>
        <d2p1:Desc>String</d2p1:Desc>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:ShortDesc>String</d2p1:ShortDesc>
      </d2p1:CustomerDefault>
      <d2p1:DlNumber>String</d2p1:DlNumber>
      <d2p1:LastModifiedDate>0001-01-01T00:00:00</d2p1:LastModifiedDate>
      <d2p1:Location>
        <d2p1:Active>false</d2p1:Active>
        <d2p1:CashSaleAcct>0</d2p1:CashSaleAcct>
        <d2p1:Desc>String</d2p1:Desc>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:InStorePickup>String</d2p1:InStorePickup>
        <d2p1:Latitude>0</d2p1:Latitude>
        <d2p1:Longitude>0</d2p1:Longitude>
        <d2p1:Region>String</d2p1:Region>
        <d2p1:ShortDesc>String</d2p1:ShortDesc>
      </d2p1:Location>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:Phone2>String</d2p1:Phone2>
      <d2p1:Phone3>String</d2p1:Phone3>
      <d2p1:Phone4>String</d2p1:Phone4>
      <d2p1:PopupNotes>String</d2p1:PopupNotes>
      <d2p1:TaxAuthority>
        <d2p1:Desc>String</d2p1:Desc>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:ShortDesc>String</d2p1:ShortDesc>
      </d2p1:TaxAuthority>
    </d2p1:AdditionalDetails>
    <d2p1:Addr1>String</d2p1:Addr1>
    <d2p1:Addr2>String</d2p1:Addr2>
    <d2p1:Barcode>String</d2p1:Barcode>
    <d2p1:City>String</d2p1:City>
    <d2p1:Color>0</d2p1:Color>
    <d2p1:DependantInfo>
      <d2p1:CustomerSearchRecord.DependantRecord>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:OnlineId>String</d2p1:OnlineId>
        <d2p1:School>String</d2p1:School>
        <d2p1:SchoolDistrict>String</d2p1:SchoolDistrict>
      </d2p1:CustomerSearchRecord.DependantRecord>
    </d2p1:DependantInfo>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Hold>false</d2p1:Hold>
    <d2p1:Last>String</d2p1:Last>
    <d2p1:MatchedOn>String</d2p1:MatchedOn>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:OpenInvoices>false</d2p1:OpenInvoices>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:Pk>0</d2p1:Pk>
    <d2p1:RentalActivity>false</d2p1:RentalActivity>
    <d2p1:St>String</d2p1:St>
    <d2p1:StLoc>String</d2p1:StLoc>
    <d2p1:Zip>String</d2p1:Zip>
  </Customer>
  <DiscountInfo>
    <AccessoryInventory>0</AccessoryInventory>
    <CategoryLevelDiscounts>
      <CategoryLevelDiscount>
        <Category>0</Category>
        <DiscountAmount>0</DiscountAmount>
        <DiscountType>String</DiscountType>
        <SubCategory>0</SubCategory>
      </CategoryLevelDiscount>
    </CategoryLevelDiscounts>
    <Labor>0</Labor>
    <MediaInventory>0</MediaInventory>
    <NonInventory>0</NonInventory>
    <PriceLevel>String</PriceLevel>
    <SerializedInventory>0</SerializedInventory>
    <ShortTermRental>0</ShortTermRental>
  </DiscountInfo>
  <Emails>
    <CustomerEmailInfo>
      <Description>String</Description>
      <Email>String</Email>
      <Method>String</Method>
      <Type>String</Type>
    </CustomerEmailInfo>
  </Emails>
  <Memberships>
    <CustomerMembershipInfo>
      <Description>String</Description>
      <StationLevel>0</StationLevel>
      <TeeLevel>0</TeeLevel>
      <WebTeeLevel>0</WebTeeLevel>
    </CustomerMembershipInfo>
  </Memberships>
</CustomerInfoResponse>