AIM Web Services

<back to all web services

UpdateCustomerRequest

UpdateCustomer
Requires active-e Customer Service.

"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

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

<UpdateCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <Attn>String</Attn>
  <CellPhone>String</CellPhone>
  <City>String</City>
  <Country>String</Country>
  <CustomerDefaultId>0</CustomerDefaultId>
  <DriversLicenseInfo>
    <Birthday>String</Birthday>
    <Ethnicity>String</Ethnicity>
    <Expiration>String</Expiration>
    <Eyes>String</Eyes>
    <Gender>String</Gender>
    <Hair>String</Hair>
    <Height>String</Height>
    <Number>String</Number>
    <State>String</State>
    <Weight>String</Weight>
  </DriversLicenseInfo>
  <Email>String</Email>
  <EmailMethod>String</EmailMethod>
  <Employer>String</Employer>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <HomePhone>String</HomePhone>
  <LocationId>0</LocationId>
  <Name>String</Name>
  <Notes>String</Notes>
  <RefreshCustomerDefaults>false</RefreshCustomerDefaults>
  <SS>String</SS>
  <State>String</State>
  <TaxAuthorityId>0</TaxAuthorityId>
  <WorkPhone>String</WorkPhone>
  <Zip>String</Zip>
</UpdateCustomerRequest>

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

<UpdateCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</UpdateCustomerResponse>