AIM Web Services

<back to all web services

ShippingAddressLookupRequest

ShippingAddressLookup
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/ShippingAddressLookup
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

            '''<Summary>
            '''The OAuthToken token return by AeServices30
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The OAuthToken token return by AeServices30", IsRequired:=true, Name:="OAuthToken", ParameterType:="Header")>
            Public Overridable Property OAuthToken As String

            '''<Summary>
            '''The Device ID of the Mobile Device. Not used for non-mobile devices.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        '''<Summary>
        '''ShippingAddressLookupRequires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class ShippingAddressLookupRequest
            Inherits BaseSecureRequest
            '''<Summary>
            '''Pass in this parameter if you want to lookup all shipping addresses linked to a customer. Not required if using a customer login. Do not pass in this parameter if passing in the ShipId parameter.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Pass in this parameter if you want to lookup all shipping addresses linked to a customer. Not required if using a customer login. Do not pass in this parameter if passing in the ShipId parameter.", Name:="Acct", ParameterType:="query")>
            Public Overridable Property Acct As Nullable(Of Integer)

            '''<Summary>
            '''Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.", Name:="ShipId", ParameterType:="query")>
            Public Overridable Property ShipId As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class ShippingAddressLookupResponse
            Inherits BaseResponse
            Public Sub New()
                ShipTos = New List(Of ShipToInfo)
            End Sub

            <DataMember>
            Public Overridable Property ShipTos As List(Of ShipToInfo)
        End Class

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

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Attention 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 Email As String

            <DataMember>
            Public Overridable Property Phone As String

            <DataMember>
            Public Overridable Property Phone2 As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Primary As Boolean

            <DataMember>
            Public Overridable Property TaxLoc As String

            <DataMember>
            Public Overridable Property Active As Boolean
        End Class
    End Namespace
End Namespace

VB.NET ShippingAddressLookupRequest 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/ShippingAddressLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ShippingAddressLookupResponse 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>
  <ShipTos>
    <ShipToInfo>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <Attention>String</Attention>
      <City>String</City>
      <Country>String</Country>
      <Email>String</Email>
      <Id>0</Id>
      <Name>String</Name>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Phone2>String</Phone2>
      <Primary>false</Primary>
      <State>String</State>
      <TaxLoc>String</TaxLoc>
      <Zip>String</Zip>
    </ShipToInfo>
  </ShipTos>
</ShippingAddressLookupResponse>