AIM Web Services

<back to all web services

UpdateCustomerRequest

UpdateCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/UpdateCustomer
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class UpdateCustomerResponse extends BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class LicenseInfo {
    /** @param {{Number?:string,Height?:string,Weight?:string,Hair?:string,Eyes?:string,Expiration?:string,Birthday?:string,Ethnicity?:string,Gender?:string,State?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Number;
    /** @type {string} */
    Height;
    /** @type {string} */
    Weight;
    /** @type {string} */
    Hair;
    /** @type {string} */
    Eyes;
    /** @type {string} */
    Expiration;
    /** @type {string} */
    Birthday;
    /** @type {string} */
    Ethnicity;
    /** @type {string} */
    Gender;
    /** @type {string} */
    State;
}
export class FormInput {
    /** @param {{Key?:string,Value?:string,Encrypted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Field Name of the Input Field */
    Key;
    /**
     * @type {string}
     * @description Value of the Input Field. */
    Value;
    /**
     * @type {boolean}
     * @description Whether or not the field is encryped with the C2B encryption key. */
    Encrypted;
}
export class UpdateCustomerRequest extends BaseSecureRequest {
    /** @param {{Acct?:number,LocationId?:number,CustomerDefaultId?:number,TaxAuthorityId?:number,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?:LicenseInfo,RefreshCustomerDefaults?:boolean,FormInputList?:FormInput[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description Customer Acct # */
    Acct;
    /**
     * @type {?number}
     * @description Location ID */
    LocationId;
    /**
     * @type {?number}
     * @description Customer Default Id */
    CustomerDefaultId;
    /**
     * @type {?number}
     * @description Tax Authority Id */
    TaxAuthorityId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Attn;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Country;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    WorkPhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    Employer;
    /** @type {string} */
    SS;
    /** @type {string} */
    Email;
    /**
     * @type {string}
     * @description Email Method. Set this to Word, PDF, HTML, or None */
    EmailMethod;
    /** @type {string} */
    Notes;
    /** @type {LicenseInfo} */
    DriversLicenseInfo;
    /**
     * @type {boolean}
     * @description If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default. */
    RefreshCustomerDefaults;
    /** @type {FormInput[]} */
    FormInputList;
}

JavaScript UpdateCustomerRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/UpdateCustomer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Acct":0,"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"},"RefreshCustomerDefaults":false,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}