AIM Web Services

SecurityRequest

Login Service

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class AccountDetail
    {
        [DataMember]
        public virtual int Acct { get; set; }

        [DataMember]
        public virtual string AcctType { get; set; }

        [DataMember]
        public virtual string Name { get; set; }
    }

    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    ///<summary>
    ///Login Service
    ///</summary>
    [DataContract]
    public partial class SecurityRequest
        : BaseRequest
    {
        ///<summary>
        ///Employee ID or Customer Email
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Employee ID or Customer Email", IsRequired=true, Name="Username", ParameterType="query")]
        public virtual string Username { get; set; }

        ///<summary>
        ///Existing Token
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Existing Token", Name="Token", ParameterType="query")]
        public virtual string Token { 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")]
        public virtual string Password { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember(Name="DeviceID")]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="DeviceID", ParameterType="query")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember(Name="AppID")]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppID", ParameterType="query")]
        public virtual string AppId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember(Name="Acct")]
        [ApiMember(DataType="int", Description="", Name="Acct", ParameterType="query")]
        public virtual int? Acct { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember(Name="DeviceName")]
        [ApiMember(DataType="string", Description="", Name="DeviceName", ParameterType="query")]
        public virtual string DeviceName { get; set; }
    }

    [DataContract]
    public partial class SecurityResponse
        : BaseResponse
    {
        public SecurityResponse()
        {
            AccountDetails = new List<AccountDetail>{};
        }

        [DataMember]
        public virtual string Token { get; set; }

        [DataMember]
        public virtual string OAuthToken { get; set; }

        [DataMember]
        public virtual string Domain { get; set; }

        [DataMember]
        public virtual bool IsAdmin { get; set; }

        [DataMember]
        public virtual UserDetail UserDetails { get; set; }

        [DataMember]
        public virtual List<AccountDetail> AccountDetails { get; set; }
    }

    [DataContract]
    public partial class UserDetail
    {
        [DataMember]
        public virtual string Firstname { get; set; }

        [DataMember]
        public virtual string LastName { get; set; }

        [DataMember]
        public virtual string Email { get; set; }

        [DataMember]
        public virtual string Type { get; set; }

        [DataMember]
        public virtual string Location { get; set; }

        [DataMember]
        public virtual string LocationName { get; set; }

        [DataMember]
        public virtual int? AccountNumber { get; set; }

        [DataMember]
        public virtual string TaxAuthority { get; set; }

        [DataMember]
        public virtual string TaxAuthorityName { get; set; }
    }

}

C# 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>