AIM Web Services

<back to all web services

InstructorInvoicesRequest

InstructorInvoices
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/InstructorInvoices
<?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 LocationInfo implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var int */
        public int $Id=0,

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

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

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

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

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

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

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

        // @DataMember
        /** @var int|null */
        public ?int $CashSaleAcct=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Desc'])) $this->Desc = $o['Desc'];
        if (isset($o['ShortDesc'])) $this->ShortDesc = $o['ShortDesc'];
        if (isset($o['Region'])) $this->Region = $o['Region'];
        if (isset($o['Latitude'])) $this->Latitude = $o['Latitude'];
        if (isset($o['Longitude'])) $this->Longitude = $o['Longitude'];
        if (isset($o['InStorePickup'])) $this->InStorePickup = $o['InStorePickup'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
        if (isset($o['CashSaleAcct'])) $this->CashSaleAcct = $o['CashSaleAcct'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Desc)) $o['Desc'] = $this->Desc;
        if (isset($this->ShortDesc)) $o['ShortDesc'] = $this->ShortDesc;
        if (isset($this->Region)) $o['Region'] = $this->Region;
        if (isset($this->Latitude)) $o['Latitude'] = $this->Latitude;
        if (isset($this->Longitude)) $o['Longitude'] = $this->Longitude;
        if (isset($this->InStorePickup)) $o['InStorePickup'] = $this->InStorePickup;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        if (isset($this->CashSaleAcct)) $o['CashSaleAcct'] = $this->CashSaleAcct;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class InstructorInvoice implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var DateTime */
        public DateTime $Date=new DateTime(),

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

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

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

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

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

        // @DataMember
        /** @var bool|null */
        public ?bool $PaidByStudent=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Date'])) $this->Date = JsonConverters::from('DateTime', $o['Date']);
        if (isset($o['InvoiceRef'])) $this->InvoiceRef = $o['InvoiceRef'];
        if (isset($o['Location'])) $this->Location = JsonConverters::from('LocationInfo', $o['Location']);
        if (isset($o['StudentName'])) $this->StudentName = $o['StudentName'];
        if (isset($o['Total'])) $this->Total = $o['Total'];
        if (isset($o['Balance'])) $this->Balance = $o['Balance'];
        if (isset($o['PaidByStudent'])) $this->PaidByStudent = $o['PaidByStudent'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Date)) $o['Date'] = JsonConverters::to('DateTime', $this->Date);
        if (isset($this->InvoiceRef)) $o['InvoiceRef'] = $this->InvoiceRef;
        if (isset($this->Location)) $o['Location'] = JsonConverters::to('LocationInfo', $this->Location);
        if (isset($this->StudentName)) $o['StudentName'] = $this->StudentName;
        if (isset($this->Total)) $o['Total'] = $this->Total;
        if (isset($this->Balance)) $o['Balance'] = $this->Balance;
        if (isset($this->PaidByStudent)) $o['PaidByStudent'] = $this->PaidByStudent;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

/** @description InstructorInvoicesRequires active-e Lesson Scheduling Service */
// @DataContract
class InstructorInvoicesRequest 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 int|null */
        public ?int $InstructorNumber=null,

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

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

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

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

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

GET /api/InstructorInvoices HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<InstructorInvoicesResponse 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>
  <InstructorInvoices>
    <InstructorInvoice>
      <Balance>0</Balance>
      <Date>0001-01-01T00:00:00</Date>
      <InvoiceRef>String</InvoiceRef>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <PaidByStudent>false</PaidByStudent>
      <StudentName>String</StudentName>
      <Total>0</Total>
    </InstructorInvoice>
  </InstructorInvoices>
</InstructorInvoicesResponse>