AIM Web Services

SecurityRequest

Login Service

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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class BaseRequest implements JsonSerializable
{
    public function __construct(
        /** @description 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 string */
        public string $ApiKey='',

        // @DataMember
        // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        /** @var string|null */
        public ?string $OAuthToken=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
        if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
        if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponseResult implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        /** @var string|null */
        public ?string $StatusCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        /** @var string|null */
        public ?string $Login=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorDisplayText=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorMessage=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        /** @var string|null */
        public ?string $DomainName=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        /** @var string|null */
        public ?string $IpAddress=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
        if (isset($o['Login'])) $this->Login = $o['Login'];
        if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
        if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
        if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
        if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
        if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
        if (isset($this->Login)) $o['Login'] = $this->Login;
        if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
        if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
        if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
        if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
        if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponse implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        /** @var BaseResponseResult|null */
        public ?BaseResponseResult $Status=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class UserDetail implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $Firstname=null,

        // @DataMember
        /** @var string|null */
        public ?string $LastName=null,

        // @DataMember
        /** @var string|null */
        public ?string $Email=null,

        // @DataMember
        /** @var string|null */
        public ?string $Type=null,

        // @DataMember
        /** @var string|null */
        public ?string $Location=null,

        // @DataMember
        /** @var string|null */
        public ?string $LocationName=null,

        // @DataMember
        /** @var int|null */
        public ?int $AccountNumber=null,

        // @DataMember
        /** @var string|null */
        public ?string $TaxAuthority=null,

        // @DataMember
        /** @var string|null */
        public ?string $TaxAuthorityName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Firstname'])) $this->Firstname = $o['Firstname'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['Location'])) $this->Location = $o['Location'];
        if (isset($o['LocationName'])) $this->LocationName = $o['LocationName'];
        if (isset($o['AccountNumber'])) $this->AccountNumber = $o['AccountNumber'];
        if (isset($o['TaxAuthority'])) $this->TaxAuthority = $o['TaxAuthority'];
        if (isset($o['TaxAuthorityName'])) $this->TaxAuthorityName = $o['TaxAuthorityName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Firstname)) $o['Firstname'] = $this->Firstname;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->Location)) $o['Location'] = $this->Location;
        if (isset($this->LocationName)) $o['LocationName'] = $this->LocationName;
        if (isset($this->AccountNumber)) $o['AccountNumber'] = $this->AccountNumber;
        if (isset($this->TaxAuthority)) $o['TaxAuthority'] = $this->TaxAuthority;
        if (isset($this->TaxAuthorityName)) $o['TaxAuthorityName'] = $this->TaxAuthorityName;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class AccountDetail implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var int */
        public int $Acct=0,

        // @DataMember
        /** @var string|null */
        public ?string $AcctType=null,

        // @DataMember
        /** @var string|null */
        public ?string $Name=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Acct'])) $this->Acct = $o['Acct'];
        if (isset($o['AcctType'])) $this->AcctType = $o['AcctType'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Acct)) $o['Acct'] = $this->Acct;
        if (isset($this->AcctType)) $o['AcctType'] = $this->AcctType;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class SecurityResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var string|null */
        public ?string $Token=null,

        // @DataMember
        /** @var string|null */
        public ?string $OAuthToken=null,

        // @DataMember
        /** @var string|null */
        public ?string $Domain=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $IsAdmin=null,

        // @DataMember
        /** @var UserDetail|null */
        public ?UserDetail $UserDetails=null,

        // @DataMember
        /** @var array<AccountDetail>|null */
        public ?array $AccountDetails=null
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Token'])) $this->Token = $o['Token'];
        if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
        if (isset($o['Domain'])) $this->Domain = $o['Domain'];
        if (isset($o['IsAdmin'])) $this->IsAdmin = $o['IsAdmin'];
        if (isset($o['UserDetails'])) $this->UserDetails = JsonConverters::from('UserDetail', $o['UserDetails']);
        if (isset($o['AccountDetails'])) $this->AccountDetails = JsonConverters::fromArray('AccountDetail', $o['AccountDetails']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Token)) $o['Token'] = $this->Token;
        if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
        if (isset($this->Domain)) $o['Domain'] = $this->Domain;
        if (isset($this->IsAdmin)) $o['IsAdmin'] = $this->IsAdmin;
        if (isset($this->UserDetails)) $o['UserDetails'] = JsonConverters::to('UserDetail', $this->UserDetails);
        if (isset($this->AccountDetails)) $o['AccountDetails'] = JsonConverters::toArray('AccountDetail', $this->AccountDetails);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Login Service */
// @DataContract
class SecurityRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        /** @description Employee ID or Customer Email */
        // @DataMember
        // @ApiMember(DataType="string", Description="Employee ID or Customer Email", IsRequired=true, Name="Username", ParameterType="query")
        /** @var string */
        public string $Username='',

        /** @description Existing Token */
        // @DataMember
        // @ApiMember(DataType="string", Description="Existing Token", Name="Token", ParameterType="query")
        /** @var string|null */
        public ?string $Token=null,

        /** @description Password of Employee or User */
        // @DataMember
        // @ApiMember(DataType="string", Description="Password of Employee or User", IsRequired=true, Name="Password", ParameterType="query")
        /** @var string */
        public string $Password='',

        /** @description  */
        // @DataMember(Name="DeviceID")
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="DeviceID", ParameterType="query")
        /** @var string */
        public string $DeviceID='',

        /** @description  */
        // @DataMember(Name="AppID")
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppID", ParameterType="query")
        /** @var string */
        public string $AppID='',

        /** @description  */
        // @DataMember(Name="Acct")
        // @ApiMember(DataType="int", Description="", Name="Acct", ParameterType="query")
        /** @var int|null */
        public ?int $Acct=null,

        /** @description  */
        // @DataMember(Name="DeviceName")
        // @ApiMember(DataType="string", Description="", Name="DeviceName", ParameterType="query")
        /** @var string|null */
        public ?string $DeviceName=null
    ) {
        parent::__construct($ApiKey,$OAuthToken);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Username'])) $this->Username = $o['Username'];
        if (isset($o['Token'])) $this->Token = $o['Token'];
        if (isset($o['Password'])) $this->Password = $o['Password'];
        if (isset($o['DeviceID'])) $this->DeviceID = $o['DeviceID'];
        if (isset($o['AppID'])) $this->AppID = $o['AppID'];
        if (isset($o['Acct'])) $this->Acct = $o['Acct'];
        if (isset($o['DeviceName'])) $this->DeviceName = $o['DeviceName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Username)) $o['Username'] = $this->Username;
        if (isset($this->Token)) $o['Token'] = $this->Token;
        if (isset($this->Password)) $o['Password'] = $this->Password;
        if (isset($this->DeviceID)) $o['DeviceID'] = $this->DeviceID;
        if (isset($this->AppID)) $o['AppID'] = $this->AppID;
        if (isset($this->Acct)) $o['Acct'] = $this->Acct;
        if (isset($this->DeviceName)) $o['DeviceName'] = $this->DeviceName;
        return empty($o) ? new class(){} : $o;
    }
}

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