AIM Web Services

<back to all web services

GetCustomerHistoryRequest

GetCustomerHistory
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/GetCustomerHistory
<?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 BaseSecureRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        /** @var string|null */
        public ?string $Token=null,

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

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        /** @var string */
        public string $AppId=''
    ) {
        parent::__construct($ApiKey,$OAuthToken);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Token'])) $this->Token = $o['Token'];
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
        if (isset($o['AppId'])) $this->AppId = $o['AppId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Token)) $o['Token'] = $this->Token;
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        if (isset($this->AppId)) $o['AppId'] = $this->AppId;
        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 CustomerHistoryGeneric implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var DateTime */
        public DateTime $Date=new DateTime(),

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

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

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

        // @DataMember
        /** @var float */
        public float $Amount=0.0,

        // @DataMember
        /** @var float */
        public float $OrigAmount=0.0,

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

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

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

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $EstReceivedDate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Date'])) $this->Date = JsonConverters::from('DateTime', $o['Date']);
        if (isset($o['DateStr'])) $this->DateStr = $o['DateStr'];
        if (isset($o['Ref'])) $this->Ref = $o['Ref'];
        if (isset($o['Desc'])) $this->Desc = $o['Desc'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['OrigAmount'])) $this->OrigAmount = $o['OrigAmount'];
        if (isset($o['Late'])) $this->Late = $o['Late'];
        if (isset($o['RefType'])) $this->RefType = $o['RefType'];
        if (isset($o['PO'])) $this->PO = $o['PO'];
        if (isset($o['EstReceivedDate'])) $this->EstReceivedDate = JsonConverters::from('DateTime', $o['EstReceivedDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Date)) $o['Date'] = JsonConverters::to('DateTime', $this->Date);
        if (isset($this->DateStr)) $o['DateStr'] = $this->DateStr;
        if (isset($this->Ref)) $o['Ref'] = $this->Ref;
        if (isset($this->Desc)) $o['Desc'] = $this->Desc;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->OrigAmount)) $o['OrigAmount'] = $this->OrigAmount;
        if (isset($this->Late)) $o['Late'] = $this->Late;
        if (isset($this->RefType)) $o['RefType'] = $this->RefType;
        if (isset($this->PO)) $o['PO'] = $this->PO;
        if (isset($this->EstReceivedDate)) $o['EstReceivedDate'] = JsonConverters::to('DateTime', $this->EstReceivedDate);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetCustomerHistoryResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var array<CustomerHistoryGeneric>|null */
        public ?array $CustomerHistory=null
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['CustomerHistory'])) $this->CustomerHistory = JsonConverters::fromArray('CustomerHistoryGeneric', $o['CustomerHistory']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->CustomerHistory)) $o['CustomerHistory'] = JsonConverters::toArray('CustomerHistoryGeneric', $this->CustomerHistory);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description GetCustomerHistoryRequires active-e Customer Service. */
// @DataContract
class GetCustomerHistoryRequest extends BaseSecureRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     * @param string|null $Token
     * @param string|null $DeviceId
     * @param string $AppId
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        ?string $Token=null,
        ?string $DeviceId=null,
        string $AppId='',
        // @DataMember
        /** @var bool|null */
        public ?bool $GetInvoices=null,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        // @DataMember
        /** @var bool|null */
        public ?bool $GetRecurringHeaderInfo=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['GetInvoices'])) $this->GetInvoices = $o['GetInvoices'];
        if (isset($o['GetTickets'])) $this->GetTickets = $o['GetTickets'];
        if (isset($o['GetProposals'])) $this->GetProposals = $o['GetProposals'];
        if (isset($o['GetContracts'])) $this->GetContracts = $o['GetContracts'];
        if (isset($o['GetOrders'])) $this->GetOrders = $o['GetOrders'];
        if (isset($o['GetShortTermRentals'])) $this->GetShortTermRentals = $o['GetShortTermRentals'];
        if (isset($o['GetWebPayments'])) $this->GetWebPayments = $o['GetWebPayments'];
        if (isset($o['ShowClosed'])) $this->ShowClosed = $o['ShowClosed'];
        if (isset($o['GetPaymentsDue'])) $this->GetPaymentsDue = $o['GetPaymentsDue'];
        if (isset($o['DateFrom'])) $this->DateFrom = $o['DateFrom'];
        if (isset($o['DateTo'])) $this->DateTo = $o['DateTo'];
        if (isset($o['Acct'])) $this->Acct = $o['Acct'];
        if (isset($o['GetMemberships'])) $this->GetMemberships = $o['GetMemberships'];
        if (isset($o['GetPendingWebOrders'])) $this->GetPendingWebOrders = $o['GetPendingWebOrders'];
        if (isset($o['GetFutureTeeTimes'])) $this->GetFutureTeeTimes = $o['GetFutureTeeTimes'];
        if (isset($o['GetStationReservations'])) $this->GetStationReservations = $o['GetStationReservations'];
        if (isset($o['GetPendingWebRentals'])) $this->GetPendingWebRentals = $o['GetPendingWebRentals'];
        if (isset($o['GetValuePacks'])) $this->GetValuePacks = $o['GetValuePacks'];
        if (isset($o['IncludeUninvoicedScheduling'])) $this->IncludeUninvoicedScheduling = $o['IncludeUninvoicedScheduling'];
        if (isset($o['IncludeOnHold'])) $this->IncludeOnHold = $o['IncludeOnHold'];
        if (isset($o['GetConsignments'])) $this->GetConsignments = $o['GetConsignments'];
        if (isset($o['GetRecurringHeaderInfo'])) $this->GetRecurringHeaderInfo = $o['GetRecurringHeaderInfo'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->GetInvoices)) $o['GetInvoices'] = $this->GetInvoices;
        if (isset($this->GetTickets)) $o['GetTickets'] = $this->GetTickets;
        if (isset($this->GetProposals)) $o['GetProposals'] = $this->GetProposals;
        if (isset($this->GetContracts)) $o['GetContracts'] = $this->GetContracts;
        if (isset($this->GetOrders)) $o['GetOrders'] = $this->GetOrders;
        if (isset($this->GetShortTermRentals)) $o['GetShortTermRentals'] = $this->GetShortTermRentals;
        if (isset($this->GetWebPayments)) $o['GetWebPayments'] = $this->GetWebPayments;
        if (isset($this->ShowClosed)) $o['ShowClosed'] = $this->ShowClosed;
        if (isset($this->GetPaymentsDue)) $o['GetPaymentsDue'] = $this->GetPaymentsDue;
        if (isset($this->DateFrom)) $o['DateFrom'] = $this->DateFrom;
        if (isset($this->DateTo)) $o['DateTo'] = $this->DateTo;
        if (isset($this->Acct)) $o['Acct'] = $this->Acct;
        if (isset($this->GetMemberships)) $o['GetMemberships'] = $this->GetMemberships;
        if (isset($this->GetPendingWebOrders)) $o['GetPendingWebOrders'] = $this->GetPendingWebOrders;
        if (isset($this->GetFutureTeeTimes)) $o['GetFutureTeeTimes'] = $this->GetFutureTeeTimes;
        if (isset($this->GetStationReservations)) $o['GetStationReservations'] = $this->GetStationReservations;
        if (isset($this->GetPendingWebRentals)) $o['GetPendingWebRentals'] = $this->GetPendingWebRentals;
        if (isset($this->GetValuePacks)) $o['GetValuePacks'] = $this->GetValuePacks;
        if (isset($this->IncludeUninvoicedScheduling)) $o['IncludeUninvoicedScheduling'] = $this->IncludeUninvoicedScheduling;
        if (isset($this->IncludeOnHold)) $o['IncludeOnHold'] = $this->IncludeOnHold;
        if (isset($this->GetConsignments)) $o['GetConsignments'] = $this->GetConsignments;
        if (isset($this->GetRecurringHeaderInfo)) $o['GetRecurringHeaderInfo'] = $this->GetRecurringHeaderInfo;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetCustomerHistoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/GetCustomerHistory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"GetInvoices":false,"GetTickets":false,"GetProposals":false,"GetContracts":false,"GetOrders":false,"GetShortTermRentals":false,"GetWebPayments":false,"ShowClosed":false,"GetPaymentsDue":false,"DateFrom":"String","DateTo":"String","Acct":0,"GetMemberships":false,"GetPendingWebOrders":false,"GetFutureTeeTimes":false,"GetStationReservations":false,"GetPendingWebRentals":false,"GetValuePacks":false,"IncludeUninvoicedScheduling":false,"IncludeOnHold":false,"GetConsignments":false,"GetRecurringHeaderInfo":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"CustomerHistory":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}