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 java.io.InputStream
import net.servicestack.client.*


/**
* CustomerInfoRequires active-e Customer Service.
*/
@DataContract
open class CustomerInfoRequest : BaseSecureRequest()
{
    @DataMember
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open var AppId:String? = null
}

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

    @DataMember
    open var DiscountInfo:CustomerDiscountInfo? = null

    @DataMember
    open var Memberships:ArrayList<CustomerMembershipInfo>? = null

    @DataMember
    open var Emails:ArrayList<CustomerEmailInfo>? = null

    @DataMember
    open var Attributes:ArrayList<AttributeValue>? = null
}

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

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

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

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

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

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

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

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

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

    @DataMember
    open var Acct:Int? = null

    @DataMember
    open var Last:String? = null

    @DataMember
    open var Name:String? = null

    @DataMember
    open var Addr1:String? = null

    @DataMember
    open var Addr2:String? = null

    @DataMember
    open var City:String? = null

    @DataMember
    open var St:String? = null

    @DataMember
    open var Zip:String? = null

    @DataMember
    open var Phone:String? = null

    @DataMember
    open var Email:String? = null

    @DataMember
    open var OpenInvoices:Boolean? = null

    @DataMember
    open var RentalActivity:Boolean? = null

    @DataMember
    open var StLoc:String? = null

    @DataMember
    open var Hold:Boolean? = null

    @DataMember
    open var Barcode:String? = null

    @DataMember
    open var Color:Int? = null

    @DataMember
    open var DependantInfo:ArrayList<DependantRecord>? = null

    @DataMember
    open var AdditionalDetails:AdditionalDetail? = null

    @DataMember
    open var MatchedOn:String? = null
}

@DataContract
open class BindableObject
{
}

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

    @DataMember
    open var OnlineId:String? = null

    @DataMember
    open var SchoolDistrict:String? = null

    @DataMember
    open var School:String? = null

    @DataMember
    open var Id:Long? = null
}

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

    @DataMember
    open var LastModifiedDate:Date? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var CustomerDefault:CustomerDefaultInfo? = null

    @DataMember
    open var TaxAuthority:TaxAuthorityInfo? = null

    @DataMember
    open var CanCharge:Boolean? = null

    @DataMember
    open var PopupNotes:String? = null

    @DataMember
    open var DlNumber:String? = null

    @DataMember
    open var Phone2:String? = null

    @DataMember
    open var Phone3:String? = null

    @DataMember
    open var Phone4:String? = null

    @DataMember
    open var Location:LocationInfo? = null
}

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

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ShortDesc:String? = null
}

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

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ShortDesc:String? = null
}

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

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ShortDesc:String? = null

    @DataMember
    open var Region:String? = null

    @DataMember
    open var Latitude:BigDecimal? = null

    @DataMember
    open var Longitude:BigDecimal? = null

    @DataMember
    open var InStorePickup:String? = null

    @DataMember
    open var Active:Boolean? = null

    @DataMember
    open var CashSaleAcct:Int? = null
}

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

    @DataMember
    open var SerializedInventory:BigDecimal? = null

    @DataMember
    open var ShortTermRental:BigDecimal? = null

    @DataMember
    open var NonInventory:BigDecimal? = null

    @DataMember
    open var Labor:BigDecimal? = null

    @DataMember
    open var MediaInventory:BigDecimal? = null

    @DataMember
    open var CategoryLevelDiscounts:ArrayList<CategoryLevelDiscount>? = null

    @DataMember
    open var PriceLevel:String? = null
}

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

    @DataMember
    open var SubCategory:Int? = null

    @DataMember
    open var DiscountType:String? = null

    @DataMember
    open var DiscountAmount:BigDecimal? = null
}

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

    @DataMember
    open var TeeLevel:Int? = null

    @DataMember
    open var WebTeeLevel:Int? = null

    @DataMember
    open var StationLevel:Int? = null
}

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

    @DataMember
    open var Email:String? = null

    @DataMember
    open var Method:String? = null

    @DataMember
    open var Type:String? = null
}

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

    @DataMember
    open var Tag:String? = null

    @DataMember
    open var Value:String? = null
}

Kotlin CustomerInfoRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"Customer":{"Pk":0,"Acct":0,"Last":"String","Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Phone":"String","Email":"String","OpenInvoices":false,"RentalActivity":false,"StLoc":"String","Hold":false,"Barcode":"String","Color":0,"DependantInfo":[{"Name":"String","OnlineId":"String","SchoolDistrict":"String","School":"String","Id":0}],"AdditionalDetails":{"Notes":"String","CustomerDefault":{"Id":0,"Desc":"String","ShortDesc":"String"},"TaxAuthority":{"Id":0,"Desc":"String","ShortDesc":"String"},"CanCharge":false,"PopupNotes":"String","DlNumber":"String","Phone2":"String","Phone3":"String","Phone4":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0}},"MatchedOn":"String"},"DiscountInfo":{"AccessoryInventory":0,"SerializedInventory":0,"ShortTermRental":0,"NonInventory":0,"Labor":0,"MediaInventory":0,"CategoryLevelDiscounts":[{"Category":0,"SubCategory":0,"DiscountType":"String","DiscountAmount":0}],"PriceLevel":"String"},"Memberships":[{"Description":"String","TeeLevel":0,"WebTeeLevel":0,"StationLevel":0}],"Emails":[{"Description":"String","Email":"String","Method":"String","Type":"String"}],"Attributes":[{"Name":"String","Tag":"String","Value":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}