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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;
using AIM.Global.Utils;

namespace AIM
{
    [DataContract]
    public partial class AttributeValue
    {
        [DataMember]
        public virtual string? Name { get; set; }

        [DataMember]
        public virtual string? Tag { get; set; }

        [DataMember]
        public virtual string? Value { get; set; }
    }

    [DataContract]
    public partial class CustomerDefaultInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string? Desc { get; set; }

        [DataMember]
        public virtual string? ShortDesc { get; set; }
    }

    [DataContract]
    public partial class CustomerSearchRecord
        : BindableObject
    {
        [DataMember]
        public virtual long Pk { get; set; }

        [DataMember]
        public virtual int Acct { get; set; }

        [DataMember]
        public virtual string? Last { get; set; }

        [DataMember]
        public virtual string? Name { get; set; }

        [DataMember]
        public virtual string? Addr1 { get; set; }

        [DataMember]
        public virtual string? Addr2 { get; set; }

        [DataMember]
        public virtual string? City { get; set; }

        [DataMember]
        public virtual string? St { get; set; }

        [DataMember]
        public virtual string? Zip { get; set; }

        [DataMember]
        public virtual string? Phone { get; set; }

        [DataMember]
        public virtual string? Email { get; set; }

        [DataMember]
        public virtual bool OpenInvoices { get; set; }

        [DataMember]
        public virtual bool RentalActivity { get; set; }

        [DataMember]
        public virtual string? StLoc { get; set; }

        [DataMember]
        public virtual bool Hold { get; set; }

        [DataMember]
        public virtual string? Barcode { get; set; }

        [DataMember]
        public virtual int Color { get; set; }

        [DataMember]
        public virtual List<DependantRecord>? DependantInfo { get; set; }

        [DataMember]
        public virtual AdditionalDetail? AdditionalDetails { get; set; }

        [DataMember]
        public virtual string? MatchedOn { get; set; }
        [DataContract]
        public partial class DependantRecord
        {
            [DataMember]
            public virtual string? Name { get; set; }

            [DataMember]
            public virtual string? OnlineId { get; set; }

            [DataMember]
            public virtual string? SchoolDistrict { get; set; }

            [DataMember]
            public virtual string? School { get; set; }

            [DataMember]
            public virtual long Id { get; set; }
        }

        [DataContract]
        public partial class AdditionalDetail
        {
            [DataMember]
            public virtual DateTime CreationDate { get; set; }

            [DataMember]
            public virtual DateTime LastModifiedDate { get; set; }

            [DataMember]
            public virtual string? Notes { get; set; }

            [DataMember]
            public virtual CustomerDefaultInfo? CustomerDefault { get; set; }

            [DataMember]
            public virtual TaxAuthorityInfo? TaxAuthority { get; set; }

            [DataMember]
            public virtual bool CanCharge { get; set; }

            [DataMember]
            public virtual string? PopupNotes { get; set; }

            [DataMember]
            public virtual string? DlNumber { get; set; }

            [DataMember]
            public virtual string? Phone2 { get; set; }

            [DataMember]
            public virtual string? Phone3 { get; set; }

            [DataMember]
            public virtual string? Phone4 { get; set; }

            [DataMember]
            public virtual LocationInfo? Location { get; set; }
        }

    }

    [DataContract]
    public partial class LocationInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string? Desc { get; set; }

        [DataMember]
        public virtual string? ShortDesc { get; set; }

        [DataMember]
        public virtual string? Region { get; set; }

        [DataMember]
        public virtual decimal Latitude { get; set; }

        [DataMember]
        public virtual decimal Longitude { get; set; }

        [DataMember]
        public virtual string? InStorePickup { get; set; }

        [DataMember]
        public virtual bool Active { get; set; }

        [DataMember]
        public virtual int? CashSaleAcct { get; set; }
    }

    [DataContract]
    public partial class TaxAuthorityInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string? Desc { get; set; }

        [DataMember]
        public virtual string? ShortDesc { get; set; }
    }

}

namespace AIM.Global.Utils
{
    [DataContract]
    public partial class BindableObject
    {
    }

}

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 virtual string ApiKey { get; set; }

        ///<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 virtual string OAuthToken { get; set; }

        ///<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 virtual string? DeviceId { get; set; }

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult? Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string? StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string? Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string? ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string? ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string? ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string? DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string? IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : 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 virtual string? Token { get; set; }
    }

    [DataContract]
    public partial class CategoryLevelDiscount
    {
        [DataMember]
        public virtual int Category { get; set; }

        [DataMember]
        public virtual int? SubCategory { get; set; }

        [DataMember]
        public virtual string? DiscountType { get; set; }

        [DataMember]
        public virtual decimal DiscountAmount { get; set; }
    }

    [DataContract]
    public partial class CustomerDiscountInfo
    {
        [DataMember]
        public virtual decimal AccessoryInventory { get; set; }

        [DataMember]
        public virtual decimal SerializedInventory { get; set; }

        [DataMember]
        public virtual decimal ShortTermRental { get; set; }

        [DataMember]
        public virtual decimal NonInventory { get; set; }

        [DataMember]
        public virtual decimal Labor { get; set; }

        [DataMember]
        public virtual decimal MediaInventory { get; set; }

        [DataMember]
        public virtual List<CategoryLevelDiscount>? CategoryLevelDiscounts { get; set; }

        [DataMember]
        public virtual string? PriceLevel { get; set; }
    }

    [DataContract]
    public partial class CustomerEmailInfo
    {
        [DataMember]
        public virtual string? Description { get; set; }

        [DataMember]
        public virtual string? Email { get; set; }

        [DataMember]
        public virtual string? Method { get; set; }

        [DataMember]
        public virtual string? Type { get; set; }
    }

    ///<summary>
    ///CustomerInfoRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class CustomerInfoRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int Acct { get; set; }
    }

    [DataContract]
    public partial class CustomerInfoResponse
        : BaseResponse
    {
        [DataMember]
        public virtual CustomerSearchRecord? Customer { get; set; }

        [DataMember]
        public virtual CustomerDiscountInfo? DiscountInfo { get; set; }

        [DataMember]
        public virtual List<CustomerMembershipInfo>? Memberships { get; set; }

        [DataMember]
        public virtual List<CustomerEmailInfo>? Emails { get; set; }

        [DataMember]
        public virtual List<AttributeValue>? Attributes { get; set; }
    }

    [DataContract]
    public partial class CustomerMembershipInfo
    {
        [DataMember]
        public virtual string? Description { get; set; }

        [DataMember]
        public virtual int TeeLevel { get; set; }

        [DataMember]
        public virtual int WebTeeLevel { get; set; }

        [DataMember]
        public virtual int StationLevel { get; set; }
    }

}

C# 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"}}