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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* CustomerInfoRequires active-e Customer Service.
*/
@DataContract
open class CustomerInfoRequest : BaseSecureRequest()
{
    @DataMember
    var Acct:Int? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class CustomerInfoResponse : BaseResponse()
{
    @DataMember
    var Customer:CustomerSearchRecord? = null

    @DataMember
    var DiscountInfo:CustomerDiscountInfo? = null

    @DataMember
    var Memberships:ArrayList<CustomerMembershipInfo> = ArrayList<CustomerMembershipInfo>()

    @DataMember
    var Emails:ArrayList<CustomerEmailInfo> = ArrayList<CustomerEmailInfo>()

    @DataMember
    var Attributes:ArrayList<AttributeValue> = ArrayList<AttributeValue>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class CustomerSearchRecord : BindableObject()
{
    @DataMember
    var Pk:Long? = null

    @DataMember
    var Acct:Int? = null

    @DataMember
    var Last:String? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Addr1:String? = null

    @DataMember
    var Addr2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var St:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Phone:String? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var OpenInvoices:Boolean? = null

    @DataMember
    var RentalActivity:Boolean? = null

    @DataMember
    var StLoc:String? = null

    @DataMember
    var Hold:Boolean? = null

    @DataMember
    var Barcode:String? = null

    @DataMember
    var Color:Int? = null

    @DataMember
    var DependantInfo:ArrayList<DependantRecord> = ArrayList<DependantRecord>()

    @DataMember
    var AdditionalDetails:AdditionalDetail? = null

    @DataMember
    var MatchedOn:String? = null
}

@DataContract
open class BindableObject
{
}

@DataContract
open class DependantRecord
{
    @DataMember
    var Name:String? = null

    @DataMember
    var OnlineId:String? = null

    @DataMember
    var SchoolDistrict:String? = null

    @DataMember
    var School:String? = null

    @DataMember
    var Id:Long? = null
}

@DataContract
open class AdditionalDetail
{
    @DataMember
    var CreationDate:Date? = null

    @DataMember
    var LastModifiedDate:Date? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var CustomerDefault:CustomerDefaultInfo? = null

    @DataMember
    var TaxAuthority:TaxAuthorityInfo? = null

    @DataMember
    var CanCharge:Boolean? = null

    @DataMember
    var PopupNotes:String? = null

    @DataMember
    var DlNumber:String? = null

    @DataMember
    var Phone2:String? = null

    @DataMember
    var Phone3:String? = null

    @DataMember
    var Phone4:String? = null

    @DataMember
    var Location:LocationInfo? = null
}

@DataContract
open class CustomerDefaultInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null
}

@DataContract
open class TaxAuthorityInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null

    @DataMember
    var Region:String? = null

    @DataMember
    var Latitude:BigDecimal? = null

    @DataMember
    var Longitude:BigDecimal? = null

    @DataMember
    var InStorePickup:String? = null

    @DataMember
    var Active:Boolean? = null

    @DataMember
    var CashSaleAcct:Int? = null
}

@DataContract
open class CustomerDiscountInfo
{
    @DataMember
    var AccessoryInventory:BigDecimal? = null

    @DataMember
    var SerializedInventory:BigDecimal? = null

    @DataMember
    var ShortTermRental:BigDecimal? = null

    @DataMember
    var NonInventory:BigDecimal? = null

    @DataMember
    var Labor:BigDecimal? = null

    @DataMember
    var MediaInventory:BigDecimal? = null

    @DataMember
    var CategoryLevelDiscounts:ArrayList<CategoryLevelDiscount> = ArrayList<CategoryLevelDiscount>()

    @DataMember
    var PriceLevel:String? = null
}

@DataContract
open class CategoryLevelDiscount
{
    @DataMember
    var Category:Int? = null

    @DataMember
    var SubCategory:Int? = null

    @DataMember
    var DiscountType:String? = null

    @DataMember
    var DiscountAmount:BigDecimal? = null
}

@DataContract
open class CustomerMembershipInfo
{
    @DataMember
    var Description:String? = null

    @DataMember
    var TeeLevel:Int? = null

    @DataMember
    var WebTeeLevel:Int? = null

    @DataMember
    var StationLevel:Int? = null
}

@DataContract
open class CustomerEmailInfo
{
    @DataMember
    var Description:String? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var Method:String? = null

    @DataMember
    var Type:String? = null
}

@DataContract
open class AttributeValue
{
    @DataMember
    var Name:String? = null

    @DataMember
    var Tag:String? = null

    @DataMember
    var Value:String? = null
}

Kotlin 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>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:AttributeValue>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Tag>String</d2p1:Tag>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:AttributeValue>
  </Attributes>
  <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>