| POST | /api/ContractFulfillment | ||
|---|---|---|---|
| POST | /api/C2BSetContractSerial |
<?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 UpdateContractErrorObj implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Ref=null,
// @DataMember
/** @var string|null */
public ?string $ErrorMessage=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Ref'])) $this->Ref = $o['Ref'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Ref)) $o['Ref'] = $this->Ref;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ContractFulfillmentResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<UpdateContractErrorObj>|null */
public ?array $MassUpdateErrors=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['MassUpdateErrors'])) $this->MassUpdateErrors = JsonConverters::fromArray('UpdateContractErrorObj', $o['MassUpdateErrors']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->MassUpdateErrors)) $o['MassUpdateErrors'] = JsonConverters::toArray('UpdateContractErrorObj', $this->MassUpdateErrors);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class DeliveredAccessory implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var bool|null */
public ?bool $Delivered=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Delivered'])) $this->Delivered = $o['Delivered'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Delivered)) $o['Delivered'] = $this->Delivered;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="Accessory")
class Accessory implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var float */
public float $Price=0.0,
// @DataMember
/** @var string|null */
public ?string $Type=null,
// @DataMember
/** @var int */
public int $CatNum=0,
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var bool|null */
public ?bool $Report=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Desc'])) $this->Desc = $o['Desc'];
if (isset($o['Price'])) $this->Price = $o['Price'];
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['CatNum'])) $this->CatNum = $o['CatNum'];
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['Report'])) $this->Report = $o['Report'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Desc)) $o['Desc'] = $this->Desc;
if (isset($this->Price)) $o['Price'] = $this->Price;
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->CatNum)) $o['CatNum'] = $this->CatNum;
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->Report)) $o['Report'] = $this->Report;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class UpdateContractObj implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Ref=null,
// @DataMember
/** @var string|null */
public ?string $Serial=null,
// @DataMember
/** @var int|null */
public ?int $SerialPk=null,
// @DataMember
/** @var float|null */
public ?float $CashPrice=null,
// @DataMember
/** @var string|null */
public ?string $NewStatus=null,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $DeliveryDate=null,
// @DataMember
/** @var array<DeliveredAccessory>|null */
public ?array $DeliveredAccessories=null,
// @DataMember
/** @var array<int>|null */
public ?array $DeletedAccessoryIds=null,
// @DataMember
/** @var array<Accessory>|null */
public ?array $AddedAccessories=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $FirstDue=null,
// @DataMember
/** @var int|null */
public ?int $NewCustomerAcct=null,
// @DataMember
/** @var bool|null */
public ?bool $Unlock=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Ref'])) $this->Ref = $o['Ref'];
if (isset($o['Serial'])) $this->Serial = $o['Serial'];
if (isset($o['SerialPk'])) $this->SerialPk = $o['SerialPk'];
if (isset($o['CashPrice'])) $this->CashPrice = $o['CashPrice'];
if (isset($o['NewStatus'])) $this->NewStatus = $o['NewStatus'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['DeliveryDate'])) $this->DeliveryDate = JsonConverters::from('DateTime', $o['DeliveryDate']);
if (isset($o['DeliveredAccessories'])) $this->DeliveredAccessories = JsonConverters::fromArray('DeliveredAccessory', $o['DeliveredAccessories']);
if (isset($o['DeletedAccessoryIds'])) $this->DeletedAccessoryIds = JsonConverters::fromArray('int', $o['DeletedAccessoryIds']);
if (isset($o['AddedAccessories'])) $this->AddedAccessories = JsonConverters::fromArray('Accessory', $o['AddedAccessories']);
if (isset($o['FirstDue'])) $this->FirstDue = JsonConverters::from('DateTime', $o['FirstDue']);
if (isset($o['NewCustomerAcct'])) $this->NewCustomerAcct = $o['NewCustomerAcct'];
if (isset($o['Unlock'])) $this->Unlock = $o['Unlock'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Ref)) $o['Ref'] = $this->Ref;
if (isset($this->Serial)) $o['Serial'] = $this->Serial;
if (isset($this->SerialPk)) $o['SerialPk'] = $this->SerialPk;
if (isset($this->CashPrice)) $o['CashPrice'] = $this->CashPrice;
if (isset($this->NewStatus)) $o['NewStatus'] = $this->NewStatus;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->DeliveryDate)) $o['DeliveryDate'] = JsonConverters::to('DateTime', $this->DeliveryDate);
if (isset($this->DeliveredAccessories)) $o['DeliveredAccessories'] = JsonConverters::toArray('DeliveredAccessory', $this->DeliveredAccessories);
if (isset($this->DeletedAccessoryIds)) $o['DeletedAccessoryIds'] = JsonConverters::toArray('int', $this->DeletedAccessoryIds);
if (isset($this->AddedAccessories)) $o['AddedAccessories'] = JsonConverters::toArray('Accessory', $this->AddedAccessories);
if (isset($this->FirstDue)) $o['FirstDue'] = JsonConverters::to('DateTime', $this->FirstDue);
if (isset($this->NewCustomerAcct)) $o['NewCustomerAcct'] = $this->NewCustomerAcct;
if (isset($this->Unlock)) $o['Unlock'] = $this->Unlock;
return empty($o) ? new class(){} : $o;
}
}
/** @description ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial. */
// @DataContract
class ContractFulfillmentRequest 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 string|null */
public ?string $Serial=null,
// @DataMember
/** @var int|null */
public ?int $SerialPk=null,
// @DataMember
/** @var float|null */
public ?float $CashPrice=null,
// @DataMember
/** @var string|null */
public ?string $NewStatus=null,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $DeliveryDate=null,
// @DataMember
/** @var array<DeliveredAccessory>|null */
public ?array $DeliveredAccessories=null,
// @DataMember
/** @var array<int>|null */
public ?array $DeletedAccessoryIds=null,
// @DataMember
/** @var array<Accessory>|null */
public ?array $AddedAccessories=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $FirstDue=null,
// @DataMember
/** @var int|null */
public ?int $CustomerAcct=null,
// @DataMember
/** @var bool|null */
public ?bool $Unlock=null,
// @DataMember
/** @var array<UpdateContractObj>|null */
public ?array $MassUpdateItems=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['Serial'])) $this->Serial = $o['Serial'];
if (isset($o['SerialPk'])) $this->SerialPk = $o['SerialPk'];
if (isset($o['CashPrice'])) $this->CashPrice = $o['CashPrice'];
if (isset($o['NewStatus'])) $this->NewStatus = $o['NewStatus'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['DeliveryDate'])) $this->DeliveryDate = JsonConverters::from('DateTime', $o['DeliveryDate']);
if (isset($o['DeliveredAccessories'])) $this->DeliveredAccessories = JsonConverters::fromArray('DeliveredAccessory', $o['DeliveredAccessories']);
if (isset($o['DeletedAccessoryIds'])) $this->DeletedAccessoryIds = JsonConverters::fromArray('int', $o['DeletedAccessoryIds']);
if (isset($o['AddedAccessories'])) $this->AddedAccessories = JsonConverters::fromArray('Accessory', $o['AddedAccessories']);
if (isset($o['FirstDue'])) $this->FirstDue = JsonConverters::from('DateTime', $o['FirstDue']);
if (isset($o['CustomerAcct'])) $this->CustomerAcct = $o['CustomerAcct'];
if (isset($o['Unlock'])) $this->Unlock = $o['Unlock'];
if (isset($o['MassUpdateItems'])) $this->MassUpdateItems = JsonConverters::fromArray('UpdateContractObj', $o['MassUpdateItems']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Ref)) $o['Ref'] = $this->Ref;
if (isset($this->Serial)) $o['Serial'] = $this->Serial;
if (isset($this->SerialPk)) $o['SerialPk'] = $this->SerialPk;
if (isset($this->CashPrice)) $o['CashPrice'] = $this->CashPrice;
if (isset($this->NewStatus)) $o['NewStatus'] = $this->NewStatus;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->DeliveryDate)) $o['DeliveryDate'] = JsonConverters::to('DateTime', $this->DeliveryDate);
if (isset($this->DeliveredAccessories)) $o['DeliveredAccessories'] = JsonConverters::toArray('DeliveredAccessory', $this->DeliveredAccessories);
if (isset($this->DeletedAccessoryIds)) $o['DeletedAccessoryIds'] = JsonConverters::toArray('int', $this->DeletedAccessoryIds);
if (isset($this->AddedAccessories)) $o['AddedAccessories'] = JsonConverters::toArray('Accessory', $this->AddedAccessories);
if (isset($this->FirstDue)) $o['FirstDue'] = JsonConverters::to('DateTime', $this->FirstDue);
if (isset($this->CustomerAcct)) $o['CustomerAcct'] = $this->CustomerAcct;
if (isset($this->Unlock)) $o['Unlock'] = $this->Unlock;
if (isset($this->MassUpdateItems)) $o['MassUpdateItems'] = JsonConverters::toArray('UpdateContractObj', $this->MassUpdateItems);
return empty($o) ? new class(){} : $o;
}
}
PHP ContractFulfillmentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/ContractFulfillment HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","CustomerAcct":0,"Unlock":false,"MassUpdateItems":[{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","NewCustomerAcct":0,"Unlock":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"MassUpdateErrors":[{"Ref":"String","ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}