AIM Web Services

<back to all web services

MobileRegistrationRequest

MobileRegistration
Requires active-e AIMMobile

The following routes are available for this service:
POST/api/MobileRegistration
"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 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 MobileRegistrationResponse extends BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class MobileRegistrationRequest extends BaseRequest {
    /** @param {{Name?:string,Phone?:string,Company?:string,Address1?:string,Address2?:string,City?:string,State?:string,Email?:string,Zip?:string,Password?:string,Action?:string,PasswordToken?:string,OptIn1?:boolean,OptIn2?:boolean,OptIn3?:boolean,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Company;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Email;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Password;
    /**
     * @type {string}
     * @description Should be Register or Confirm */
    Action;
    /** @type {string} */
    PasswordToken;
    /** @type {boolean} */
    OptIn1;
    /** @type {boolean} */
    OptIn2;
    /** @type {boolean} */
    OptIn3;
}

JavaScript MobileRegistrationRequest DTOs

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

HTTP + XML

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

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

<MobileRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <Action>String</Action>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <City>String</City>
  <Company>String</Company>
  <Email>String</Email>
  <Name>String</Name>
  <OptIn1>false</OptIn1>
  <OptIn2>false</OptIn2>
  <OptIn3>false</OptIn3>
  <Password>String</Password>
  <PasswordToken>String</PasswordToken>
  <Phone>String</Phone>
  <State>String</State>
  <Zip>String</Zip>
</MobileRegistrationRequest>

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

<MobileRegistrationResponse 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>
</MobileRegistrationResponse>