AIM Web Services

SecurityRequest

Login Service

The following routes are available for this service:
POST	/api/Security
POST	/api/Security/{token}

"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 UserDetail {
    /** @param {{Firstname?:string,LastName?:string,Email?:string,Type?:string,Location?:string,LocationName?:string,AccountNumber?:number,TaxAuthority?:string,TaxAuthorityName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Firstname;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Email;
    /** @type {string} */
    Type;
    /** @type {string} */
    Location;
    /** @type {string} */
    LocationName;
    /** @type {?number} */
    AccountNumber;
    /** @type {string} */
    TaxAuthority;
    /** @type {string} */
    TaxAuthorityName;
}
export class AccountDetail {
    /** @param {{Acct?:number,AcctType?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Acct;
    /** @type {string} */
    AcctType;
    /** @type {string} */
    Name;
}
export class SecurityResponse extends BaseResponse {
    /** @param {{Token?:string,OAuthToken?:string,Domain?:string,IsAdmin?:boolean,UserDetails?:UserDetail,AccountDetails?:AccountDetail[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    OAuthToken;
    /** @type {string} */
    Domain;
    /** @type {boolean} */
    IsAdmin;
    /** @type {UserDetail} */
    UserDetails;
    /** @type {AccountDetail[]} */
    AccountDetails;
}
export class SecurityRequest extends BaseRequest {
    /** @param {{Username?:string,Token?:string,Password?:string,DeviceID?:string,AppID?:string,Acct?:number,DeviceName?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Employee ID or Customer Email */
    Username;
    /**
     * @type {string}
     * @description Existing Token */
    Token;
    /**
     * @type {string}
     * @description Password of Employee or User */
    Password;
    /** @type {string} */
    DeviceID;
    /** @type {string} */
    AppID;
    /** @type {?number} */
    Acct;
    /** @type {string} */
    DeviceName;
}

JavaScript SecurityRequest 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/Security HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Username":"String","Token":"String","Password":"String","DeviceID":"String","AppID":"String","Acct":0,"DeviceName":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Token":"String","OAuthToken":"String","Domain":"String","IsAdmin":false,"UserDetails":{"Firstname":"String","LastName":"String","Email":"String","Type":"String","Location":"String","LocationName":"String","AccountNumber":0,"TaxAuthority":"String","TaxAuthorityName":"String"},"AccountDetails":[{"Acct":0,"AcctType":"String","Name":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}