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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BindableObject() = 
        class end

    [<DataContract>]
    [<AllowNullLiteral>]
    type DependantRecord() = 
        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val OnlineId:String = null with get,set

        [<DataMember>]
        member val SchoolDistrict:String = null with get,set

        [<DataMember>]
        member val School:String = null with get,set

        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerDefaultInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val ShortDesc:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type TaxAuthorityInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val ShortDesc:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type LocationInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val ShortDesc:String = null with get,set

        [<DataMember>]
        member val Region:String = null with get,set

        [<DataMember>]
        member val Latitude:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Longitude:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val InStorePickup:String = null with get,set

        [<DataMember>]
        member val Active:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CashSaleAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AdditionalDetail() = 
        [<DataMember>]
        member val CreationDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val LastModifiedDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val CustomerDefault:CustomerDefaultInfo = null with get,set

        [<DataMember>]
        member val TaxAuthority:TaxAuthorityInfo = null with get,set

        [<DataMember>]
        member val CanCharge:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val PopupNotes:String = null with get,set

        [<DataMember>]
        member val DlNumber:String = null with get,set

        [<DataMember>]
        member val Phone2:String = null with get,set

        [<DataMember>]
        member val Phone3:String = null with get,set

        [<DataMember>]
        member val Phone4:String = null with get,set

        [<DataMember>]
        member val Location:LocationInfo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerSearchRecord() = 
        inherit BindableObject()
        [<DataMember>]
        member val Pk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Acct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Last:String = null with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Addr1:String = null with get,set

        [<DataMember>]
        member val Addr2:String = null with get,set

        [<DataMember>]
        member val City:String = null with get,set

        [<DataMember>]
        member val St:String = null with get,set

        [<DataMember>]
        member val Zip:String = null with get,set

        [<DataMember>]
        member val Phone:String = null with get,set

        [<DataMember>]
        member val Email:String = null with get,set

        [<DataMember>]
        member val OpenInvoices:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val RentalActivity:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val StLoc:String = null with get,set

        [<DataMember>]
        member val Hold:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Barcode:String = null with get,set

        [<DataMember>]
        member val Color:Int32 = new Int32() with get,set

        [<DataMember>]
        member val DependantInfo:ResizeArray<DependantRecord> = new ResizeArray<DependantRecord>() with get,set

        [<DataMember>]
        member val AdditionalDetails:AdditionalDetail = null with get,set

        [<DataMember>]
        member val MatchedOn:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CategoryLevelDiscount() = 
        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val SubCategory:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val DiscountType:String = null with get,set

        [<DataMember>]
        member val DiscountAmount:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerDiscountInfo() = 
        [<DataMember>]
        member val AccessoryInventory:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val SerializedInventory:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ShortTermRental:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val NonInventory:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Labor:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val MediaInventory:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val CategoryLevelDiscounts:ResizeArray<CategoryLevelDiscount> = new ResizeArray<CategoryLevelDiscount>() with get,set

        [<DataMember>]
        member val PriceLevel:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerMembershipInfo() = 
        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val TeeLevel:Int32 = new Int32() with get,set

        [<DataMember>]
        member val WebTeeLevel:Int32 = new Int32() with get,set

        [<DataMember>]
        member val StationLevel:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerEmailInfo() = 
        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Email:String = null with get,set

        [<DataMember>]
        member val Method:String = null with get,set

        [<DataMember>]
        member val Type:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerInfoResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Customer:CustomerSearchRecord = null with get,set

        [<DataMember>]
        member val DiscountInfo:CustomerDiscountInfo = null with get,set

        [<DataMember>]
        member val Memberships:ResizeArray<CustomerMembershipInfo> = new ResizeArray<CustomerMembershipInfo>() with get,set

        [<DataMember>]
        member val Emails:ResizeArray<CustomerEmailInfo> = new ResizeArray<CustomerEmailInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///CustomerInfoRequires active-e Customer Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerInfoRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Acct:Int32 = new Int32() with get,set

F# 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>