AIM Web Services

<back to all web services

AddCustomerRequest

AddCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/AddCustomer
using System;
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 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
    {
        public CustomerSearchRecord()
        {
            DependantInfo = new List<DependantRecord>{};
        }

        [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
{
    ///<summary>
    ///AddCustomerRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class AddCustomerRequest
        : BaseSecureRequest
    {
        public AddCustomerRequest()
        {
            FormInputList = new List<FormInput>{};
        }

        ///<summary>
        ///Location ID
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")]
        public virtual long? LocationId { get; set; }

        ///<summary>
        ///Customer Default Id
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")]
        public virtual long? CustomerDefaultId { get; set; }

        ///<summary>
        ///Tax Authority Id
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, Name="TaxAuthorityId", ParameterType="query")]
        public virtual long? TaxAuthorityId { get; set; }

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

        [DataMember]
        public virtual string Attn { get; set; }

        [DataMember]
        public virtual string Address1 { get; set; }

        [DataMember]
        public virtual string Address2 { get; set; }

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

        [DataMember]
        public virtual string State { get; set; }

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

        [DataMember]
        public virtual string Country { get; set; }

        [DataMember]
        public virtual string HomePhone { get; set; }

        [DataMember]
        public virtual string WorkPhone { get; set; }

        [DataMember]
        public virtual string CellPhone { get; set; }

        [DataMember]
        public virtual string Employer { get; set; }

        [DataMember]
        public virtual string SS { get; set; }

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

        ///<summary>
        ///Email Method. Set this to Word, PDF, HTML, or None
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Email Method. Set this to Word, PDF, HTML, or None", Name="EmailMethod", ParameterType="query")]
        public virtual string EmailMethod { get; set; }

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

        [DataMember]
        public virtual LicenseInfo DriversLicenseInfo { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")]
        public virtual List<FormInput> FormInputList { get; set; }

        ///<summary>
        ///Can be SKIP, CHECK, or CHECKONLY. Defaults to SKIP. SKIP will not do a duplicate check. CHECK will do a duplicate check and the customer will not added if duplicates are found. CHECKONLY will just do a duplicate check; the customer will not be added. Duplicate check logic is based on the AIM system variable CustDupCheck.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Can be SKIP, CHECK, or CHECKONLY. Defaults to SKIP. SKIP will not do a duplicate check. CHECK will do a duplicate check and the customer will not added if duplicates are found. CHECKONLY will just do a duplicate check; the customer will not be added. Duplicate check logic is based on the AIM system variable CustDupCheck.", Name="DuplicateCheckMode")]
        public virtual string DuplicateCheckMode { get; set; }
        [DataContract]
        public partial class LicenseInfo
        {
            [DataMember]
            public virtual string Number { get; set; }

            [DataMember]
            public virtual string Height { get; set; }

            [DataMember]
            public virtual string Weight { get; set; }

            [DataMember]
            public virtual string Hair { get; set; }

            [DataMember]
            public virtual string Eyes { get; set; }

            [DataMember]
            public virtual string Expiration { get; set; }

            [DataMember]
            public virtual string Birthday { get; set; }

            [DataMember]
            public virtual string Ethnicity { get; set; }

            [DataMember]
            public virtual string Gender { get; set; }

            [DataMember]
            public virtual string State { get; set; }
        }

    }

    [DataContract]
    public partial class AddCustomerResponse
        : BaseResponse
    {
        public AddCustomerResponse()
        {
            PossibleDuplicates = new List<CustomerSearchRecord>{};
        }

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

        ///<summary>
        ///Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.", Name="PossibleDuplicates")]
        public virtual List<CustomerSearchRecord> PossibleDuplicates { get; set; }
    }

    [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; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { 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>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

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

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

    [DataContract(Name="FormInput")]
    public partial class FormInput
    {
        ///<summary>
        ///Field Name of the Input Field
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")]
        public virtual string Key { get; set; }

        ///<summary>
        ///Value of the Input Field.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")]
        public virtual string Value { get; set; }

        ///<summary>
        ///Whether or not the field is encryped with the C2B encryption key.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")]
        public virtual bool Encrypted { get; set; }
    }

}

C# AddCustomerRequest 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.

POST /api/AddCustomer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LocationId":0,"CustomerDefaultId":0,"TaxAuthorityId":0,"Name":"String","Attn":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","HomePhone":"String","WorkPhone":"String","CellPhone":"String","Employer":"String","SS":"String","Email":"String","EmailMethod":"String","Notes":"String","DriversLicenseInfo":{"Number":"String","Height":"String","Weight":"String","Hair":"String","Eyes":"String","Expiration":"String","Birthday":"String","Ethnicity":"String","Gender":"String","State":"String"},"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"DuplicateCheckMode":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Id":0,"PossibleDuplicates":[{"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"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}