AIM Web Services

SecurityRequest

Login Service

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

namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UserDetail() = 
        [<DataMember>]
        member val Firstname:String = null with get,set

        [<DataMember>]
        member val LastName:String = null with get,set

        [<DataMember>]
        member val Email:String = null with get,set

        [<DataMember>]
        member val Type:String = null with get,set

        [<DataMember>]
        member val Location:String = null with get,set

        [<DataMember>]
        member val LocationName:String = null with get,set

        [<DataMember>]
        member val AccountNumber:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val TaxAuthority:String = null with get,set

        [<DataMember>]
        member val TaxAuthorityName:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AccountDetail() = 
        [<DataMember>]
        member val Acct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val AcctType:String = null with get,set

        [<DataMember>]
        member val Name:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SecurityResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Token:String = null with get,set

        [<DataMember>]
        member val OAuthToken:String = null with get,set

        [<DataMember>]
        member val Domain:String = null with get,set

        [<DataMember>]
        member val IsAdmin:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val UserDetails:UserDetail = null with get,set

        [<DataMember>]
        member val AccountDetails:ResizeArray<AccountDetail> = new ResizeArray<AccountDetail>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")>]
        member val OAuthToken:String = null with get,set

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///Login Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type SecurityRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///Employee ID or Customer Email
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Employee ID or Customer Email", IsRequired=true, Name="Username", ParameterType="query")>]
        member val Username:String = null with get,set

        ///<summary>
        ///Existing Token
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Existing Token", Name="Token", ParameterType="query")>]
        member val Token:String = null with get,set

        ///<summary>
        ///Password of Employee or User
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Password of Employee or User", IsRequired=true, Name="Password", ParameterType="query")>]
        member val Password:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember(Name="DeviceID")>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="DeviceID", ParameterType="query")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember(Name="AppID")>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppID", ParameterType="query")>]
        member val AppId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember(Name="Acct")>]
        [<ApiMember(DataType="int", Description="", Name="Acct", ParameterType="query")>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember(Name="DeviceName")>]
        [<ApiMember(DataType="string", Description="", Name="DeviceName", ParameterType="query")>]
        member val DeviceName:String = null with get,set

F# 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>
  <AppId i:nil="true" />
  <DeviceId i:nil="true" />
  <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>