AIM Web Services

SecurityRequest

Login Service

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Login Service
*/
@DataContract
open class SecurityRequest : BaseRequest()
{
    /**
    * Employee ID or Customer Email
    */
    @DataMember
    @ApiMember(DataType="string", Description="Employee ID or Customer Email", IsRequired=true, Name="Username", ParameterType="query")
    var Username:String? = null

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

    /**
    * Password of Employee or User
    */
    @DataMember
    @ApiMember(DataType="string", Description="Password of Employee or User", IsRequired=true, Name="Password", ParameterType="query")
    var Password:String? = null

    /**
    * 
    */
    @DataMember(Name="DeviceID")
    @SerializedName("DeviceID")
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="DeviceID", ParameterType="query")
    var DeviceId:String? = null

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

    /**
    * 
    */
    @DataMember(Name="Acct")
    @SerializedName("Acct")
    @ApiMember(DataType="int", Description="", Name="Acct", ParameterType="query")
    var Acct:Int? = null

    /**
    * 
    */
    @DataMember(Name="DeviceName")
    @SerializedName("DeviceName")
    @ApiMember(DataType="string", Description="", Name="DeviceName", ParameterType="query")
    var DeviceName: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 SecurityResponse : BaseResponse()
{
    @DataMember
    var Token:String? = null

    @DataMember
    var OAuthToken:String? = null

    @DataMember
    var Domain:String? = null

    @DataMember
    var IsAdmin:Boolean? = null

    @DataMember
    var UserDetails:UserDetail? = null

    @DataMember
    var AccountDetails:ArrayList<AccountDetail> = ArrayList<AccountDetail>()
}

@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 UserDetail
{
    @DataMember
    var Firstname:String? = null

    @DataMember
    var LastName:String? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var Type:String? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var LocationName:String? = null

    @DataMember
    var AccountNumber:Int? = null

    @DataMember
    var TaxAuthority:String? = null

    @DataMember
    var TaxAuthorityName:String? = null
}

@DataContract
open class AccountDetail
{
    @DataMember
    var Acct:Int? = null

    @DataMember
    var AcctType:String? = null

    @DataMember
    var Name:String? = null
}

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

<SecurityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <Acct>0</Acct>
  <AppID>String</AppID>
  <DeviceID>String</DeviceID>
  <DeviceName>String</DeviceName>
  <Password>String</Password>
  <Token>String</Token>
  <Username>String</Username>
</SecurityRequest>

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

<SecurityResponse 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>
  <AccountDetails>
    <AccountDetail>
      <Acct>0</Acct>
      <AcctType>String</AcctType>
      <Name>String</Name>
    </AccountDetail>
  </AccountDetails>
  <Domain>String</Domain>
  <IsAdmin>false</IsAdmin>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <UserDetails>
    <AccountNumber>0</AccountNumber>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <LastName>String</LastName>
    <Location>String</Location>
    <LocationName>String</LocationName>
    <TaxAuthority>String</TaxAuthority>
    <TaxAuthorityName>String</TaxAuthorityName>
    <Type>String</Type>
  </UserDetails>
</SecurityResponse>