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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* AnalyticChartTypesRequires active-e Mobile Employee Service
*/
@DataContract
open class AnalyticChartTypesRequest : BaseSecureRequest()
{
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class AnalyticChartTypesResponse : BaseResponse()
{
    @DataMember
    var ReportTypes:ArrayList<AnalyticChartType> = ArrayList<AnalyticChartType>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class AnalyticChartType
{
    @DataMember
    var Key:Long? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var ReportPrefs:ArrayList<AnalyticChartPref> = ArrayList<AnalyticChartPref>()
}

@DataContract
open class AnalyticChartPref
{
    @DataMember
    var Key:Long? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var StartDate:Date? = null

    @DataMember
    var EndDate:Date? = null
}

Kotlin 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>