AIM Web Services

<back to all web services

AnalyticChartTypesRequest

AnalyticChartTypes
Requires active-e Mobile Employee Service

The following routes are available for this service:
GET/api/AnalyticChartTypes
GET/api/DashboardReportTypes
"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 AnalyticChartPref {
    /** @param {{Key?:number,Name?:string,StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Key;
    /** @type {string} */
    Name;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}
export class AnalyticChartType {
    /** @param {{Key?:number,Name?:string,ReportPrefs?:AnalyticChartPref[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Key;
    /** @type {string} */
    Name;
    /** @type {AnalyticChartPref[]} */
    ReportPrefs;
}
export class AnalyticChartTypesResponse extends BaseResponse {
    /** @param {{ReportTypes?:AnalyticChartType[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AnalyticChartType[]} */
    ReportTypes;
}
export class AnalyticChartTypesRequest extends BaseSecureRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript AnalyticChartTypesRequest 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.

GET /api/AnalyticChartTypes HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<AnalyticChartTypesResponse 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>
  <ReportTypes>
    <AnalyticChartTypesResponse.AnalyticChartType>
      <Key>0</Key>
      <Name>String</Name>
      <ReportPrefs>
        <AnalyticChartTypesResponse.AnalyticChartPref>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <Key>0</Key>
          <Name>String</Name>
          <StartDate>0001-01-01T00:00:00</StartDate>
        </AnalyticChartTypesResponse.AnalyticChartPref>
      </ReportPrefs>
    </AnalyticChartTypesResponse.AnalyticChartType>
  </ReportTypes>
</AnalyticChartTypesResponse>