AIM Web Services

<back to all web services

GetContractDetailsRequest

GetContractDetails
Requires active-e Contracts Service or active-e Customer Service

The following routes are available for this service:
POST, GET/api/GetContractDetails
<?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 InventoryGeneric implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $Model=null,

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

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

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

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

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

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

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

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

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

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

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

        // @DataMember
        /** @var DateTime */
        public DateTime $NextDueDate=new DateTime(),

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

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

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

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

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

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

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

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

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

        // @DataMember
        /** @var array<InventoryGeneric>|null */
        public ?array $Inventory=null,

        // @DataMember
        /** @var array<PaymentGeneric>|null */
        public ?array $Payments=null,

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

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

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

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

        // @DataMember
        /** @var float|null */
        public ?float $DiscountedPayoff=null,

        // @DataMember
        /** @var DateTime */
        public DateTime $PayoffDate=new DateTime()
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['AccountSub'])) $this->AccountSub = $o['AccountSub'];
        if (isset($o['NextDueDate'])) $this->NextDueDate = JsonConverters::from('DateTime', $o['NextDueDate']);
        if (isset($o['PaymentAmount'])) $this->PaymentAmount = $o['PaymentAmount'];
        if (isset($o['PastDueAmount'])) $this->PastDueAmount = $o['PastDueAmount'];
        if (isset($o['LateCharges'])) $this->LateCharges = $o['LateCharges'];
        if (isset($o['OtherCharges'])) $this->OtherCharges = $o['OtherCharges'];
        if (isset($o['TotalDue'])) $this->TotalDue = $o['TotalDue'];
        if (isset($o['AccumulatedCredit'])) $this->AccumulatedCredit = $o['AccumulatedCredit'];
        if (isset($o['StudentName'])) $this->StudentName = $o['StudentName'];
        if (isset($o['SchoolName'])) $this->SchoolName = $o['SchoolName'];
        if (isset($o['Topic'])) $this->Topic = $o['Topic'];
        if (isset($o['Inventory'])) $this->Inventory = JsonConverters::fromArray('InventoryGeneric', $o['Inventory']);
        if (isset($o['Payments'])) $this->Payments = JsonConverters::fromArray('PaymentGeneric', $o['Payments']);
        if (isset($o['PaymentAmt'])) $this->PaymentAmt = $o['PaymentAmt'];
        if (isset($o['PastDueAmt'])) $this->PastDueAmt = $o['PastDueAmt'];
        if (isset($o['CurrentBalance'])) $this->CurrentBalance = $o['CurrentBalance'];
        if (isset($o['TotalPayoff'])) $this->TotalPayoff = $o['TotalPayoff'];
        if (isset($o['DiscountedPayoff'])) $this->DiscountedPayoff = $o['DiscountedPayoff'];
        if (isset($o['PayoffDate'])) $this->PayoffDate = JsonConverters::from('DateTime', $o['PayoffDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->AccountSub)) $o['AccountSub'] = $this->AccountSub;
        if (isset($this->NextDueDate)) $o['NextDueDate'] = JsonConverters::to('DateTime', $this->NextDueDate);
        if (isset($this->PaymentAmount)) $o['PaymentAmount'] = $this->PaymentAmount;
        if (isset($this->PastDueAmount)) $o['PastDueAmount'] = $this->PastDueAmount;
        if (isset($this->LateCharges)) $o['LateCharges'] = $this->LateCharges;
        if (isset($this->OtherCharges)) $o['OtherCharges'] = $this->OtherCharges;
        if (isset($this->TotalDue)) $o['TotalDue'] = $this->TotalDue;
        if (isset($this->AccumulatedCredit)) $o['AccumulatedCredit'] = $this->AccumulatedCredit;
        if (isset($this->StudentName)) $o['StudentName'] = $this->StudentName;
        if (isset($this->SchoolName)) $o['SchoolName'] = $this->SchoolName;
        if (isset($this->Topic)) $o['Topic'] = $this->Topic;
        if (isset($this->Inventory)) $o['Inventory'] = JsonConverters::toArray('InventoryGeneric', $this->Inventory);
        if (isset($this->Payments)) $o['Payments'] = JsonConverters::toArray('PaymentGeneric', $this->Payments);
        if (isset($this->PaymentAmt)) $o['PaymentAmt'] = $this->PaymentAmt;
        if (isset($this->PastDueAmt)) $o['PastDueAmt'] = $this->PastDueAmt;
        if (isset($this->CurrentBalance)) $o['CurrentBalance'] = $this->CurrentBalance;
        if (isset($this->TotalPayoff)) $o['TotalPayoff'] = $this->TotalPayoff;
        if (isset($this->DiscountedPayoff)) $o['DiscountedPayoff'] = $this->DiscountedPayoff;
        if (isset($this->PayoffDate)) $o['PayoffDate'] = JsonConverters::to('DateTime', $this->PayoffDate);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description GetContractDetailsRequires active-e Contracts Service or active-e Customer Service */
// @DataContract
class GetContractDetailsRequest 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 string|null */
        public ?string $Ref=null,

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

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

PHP GetContractDetailsRequest 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/GetContractDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Ref":"String","Sub":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"AccountSub":"String","PaymentAmount":0,"PastDueAmount":0,"LateCharges":0,"OtherCharges":0,"TotalDue":0,"AccumulatedCredit":0,"StudentName":"String","SchoolName":"String","Topic":"String","Inventory":[{"Model":"String","Item":"String","Sku":"String","Serial":"String","Desc":"String","Mfg":"String"}],"Payments":[{"Amount":0,"Ref":"String"}],"PaymentAmt":0,"PastDueAmt":0,"CurrentBalance":0,"TotalPayoff":0,"DiscountedPayoff":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}