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
// @ts-nocheck

// @DataContract
export class BaseRequest
{
    /** @description 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")
    public ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description 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")
    public DeviceId?: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description 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")
    public Token?: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress?: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status?: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BindableObject
{

    public constructor(init?: Partial<BindableObject>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DependantRecord
{
    // @DataMember
    public Name?: string;

    // @DataMember
    public OnlineId?: string;

    // @DataMember
    public SchoolDistrict?: string;

    // @DataMember
    public School?: string;

    // @DataMember
    public Id: number;

    public constructor(init?: Partial<DependantRecord>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerDefaultInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc?: string;

    // @DataMember
    public ShortDesc?: string;

    public constructor(init?: Partial<CustomerDefaultInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TaxAuthorityInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc?: string;

    // @DataMember
    public ShortDesc?: string;

    public constructor(init?: Partial<TaxAuthorityInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class LocationInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc?: string;

    // @DataMember
    public ShortDesc?: string;

    // @DataMember
    public Region?: string;

    // @DataMember
    public Latitude: number;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public InStorePickup?: string;

    // @DataMember
    public Active: boolean;

    // @DataMember
    public CashSaleAcct?: number;

    public constructor(init?: Partial<LocationInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AdditionalDetail
{
    // @DataMember
    public CreationDate: string;

    // @DataMember
    public LastModifiedDate: string;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public CustomerDefault?: CustomerDefaultInfo;

    // @DataMember
    public TaxAuthority?: TaxAuthorityInfo;

    // @DataMember
    public CanCharge: boolean;

    // @DataMember
    public PopupNotes?: string;

    // @DataMember
    public DlNumber?: string;

    // @DataMember
    public Phone2?: string;

    // @DataMember
    public Phone3?: string;

    // @DataMember
    public Phone4?: string;

    // @DataMember
    public Location?: LocationInfo;

    public constructor(init?: Partial<AdditionalDetail>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerSearchRecord extends BindableObject
{
    // @DataMember
    public Pk: number;

    // @DataMember
    public Acct: number;

    // @DataMember
    public Last?: string;

    // @DataMember
    public Name?: string;

    // @DataMember
    public Addr1?: string;

    // @DataMember
    public Addr2?: string;

    // @DataMember
    public City?: string;

    // @DataMember
    public St?: string;

    // @DataMember
    public Zip?: string;

    // @DataMember
    public Phone?: string;

    // @DataMember
    public Email?: string;

    // @DataMember
    public OpenInvoices: boolean;

    // @DataMember
    public RentalActivity: boolean;

    // @DataMember
    public StLoc?: string;

    // @DataMember
    public Hold: boolean;

    // @DataMember
    public Barcode?: string;

    // @DataMember
    public Color: number;

    // @DataMember
    public DependantInfo?: DependantRecord[];

    // @DataMember
    public AdditionalDetails?: AdditionalDetail;

    // @DataMember
    public MatchedOn?: string;

    public constructor(init?: Partial<CustomerSearchRecord>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AddCustomerResponse extends BaseResponse
{
    // @DataMember
    public Id?: number;

    /** @description 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")
    public PossibleDuplicates?: CustomerSearchRecord[];

    public constructor(init?: Partial<AddCustomerResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class LicenseInfo
{
    // @DataMember
    public Number?: string;

    // @DataMember
    public Height?: string;

    // @DataMember
    public Weight?: string;

    // @DataMember
    public Hair?: string;

    // @DataMember
    public Eyes?: string;

    // @DataMember
    public Expiration?: string;

    // @DataMember
    public Birthday?: string;

    // @DataMember
    public Ethnicity?: string;

    // @DataMember
    public Gender?: string;

    // @DataMember
    public State?: string;

    public constructor(init?: Partial<LicenseInfo>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="FormInput")
export class FormInput
{
    /** @description Field name of the Input Field. If linking to an Attribute, this should match the Tag value. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Field name of the Input Field. If linking to an Attribute, this should match the Tag value.", IsRequired=true, Name="Key", ParameterType="body")
    public Key: string;

    /** @description Value of the Input Field. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="body")
    public Value: string;

    /** @description 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.", Name="Encrypted", ParameterType="body")
    public Encrypted: boolean;

    public constructor(init?: Partial<FormInput>) { (Object as any).assign(this, init); }
}

/** @description AddCustomerRequires active-e Customer Service. */
// @DataContract
export class AddCustomerRequest extends BaseSecureRequest
{
    /** @description Location ID */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    public LocationId: number;

    /** @description Customer Default Id */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")
    public CustomerDefaultId: number;

    /** @description Tax Authority Id */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, Name="TaxAuthorityId", ParameterType="query")
    public TaxAuthorityId: number;

    // @DataMember
    public Name?: string;

    // @DataMember
    public Attn?: string;

    // @DataMember
    public Address1?: string;

    // @DataMember
    public Address2?: string;

    // @DataMember
    public City?: string;

    // @DataMember
    public State?: string;

    // @DataMember
    public Zip?: string;

    // @DataMember
    public Country?: string;

    // @DataMember
    public HomePhone?: string;

    // @DataMember
    public WorkPhone?: string;

    // @DataMember
    public CellPhone?: string;

    // @DataMember
    public Employer?: string;

    // @DataMember
    public SS?: string;

    // @DataMember
    public Email?: string;

    /** @description 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")
    public EmailMethod?: string;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public DriversLicenseInfo?: LicenseInfo;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    public FormInputList?: FormInput[];

    /** @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. */
    // @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 DuplicateCheckMode?: string;

    public constructor(init?: Partial<AddCustomerRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"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"}}