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


/**
* AddCustomerRequires active-e Customer Service.
*/
@DataContract
open class AddCustomerRequest : BaseSecureRequest()
{
    /**
    * Location ID
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    var LocationId:Long? = null

    /**
    * Customer Default Id
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")
    var CustomerDefaultId:Long? = null

    /**
    * Tax Authority Id
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, Name="TaxAuthorityId", ParameterType="query")
    var TaxAuthorityId:Long? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Attn:String? = null

    @DataMember
    var Address1:String? = null

    @DataMember
    var Address2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var State:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Country:String? = null

    @DataMember
    var HomePhone:String? = null

    @DataMember
    var WorkPhone:String? = null

    @DataMember
    var CellPhone:String? = null

    @DataMember
    var Employer:String? = null

    @DataMember
    var SS:String? = null

    @DataMember
    var Email:String? = null

    /**
    * Email Method. Set this to Word, PDF, HTML, or None
    */
    @DataMember
    @ApiMember(DataType="string", Description="Email Method. Set this to Word, PDF, HTML, or None", Name="EmailMethod", ParameterType="query")
    var EmailMethod:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var DriversLicenseInfo:LicenseInfo? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    var FormInputList:ArrayList<FormInput> = ArrayList<FormInput>()

    /**
    * 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.
    */
    @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")
    var DuplicateCheckMode:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId: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

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class LicenseInfo
{
    @DataMember
    var Number:String? = null

    @DataMember
    var Height:String? = null

    @DataMember
    var Weight:String? = null

    @DataMember
    var Hair:String? = null

    @DataMember
    var Eyes:String? = null

    @DataMember
    var Expiration:String? = null

    @DataMember
    var Birthday:String? = null

    @DataMember
    var Ethnicity:String? = null

    @DataMember
    var Gender:String? = null

    @DataMember
    var State:String? = null
}

@DataContract(Name="FormInput")
open class FormInput
{
    /**
    * Field Name of the Input Field
    */
    @DataMember
    @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    var Key:String? = null

    /**
    * Value of the Input Field.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    var Value:String? = null

    /**
    * Whether or not the field is encryped with the C2B encryption key.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    var Encrypted:Boolean? = null
}

@DataContract
open class AddCustomerResponse : BaseResponse()
{
    @DataMember
    var Id:Int? = null

    /**
    * Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.
    */
    @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")
    var PossibleDuplicates:ArrayList<CustomerSearchRecord> = ArrayList<CustomerSearchRecord>()
}

@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
}

Kotlin 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"}}