| POST, GET | /api/C2BGetInstrumentDetail |
|---|
<?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 C2BPlanCodeGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Code=null,
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var int */
public int $Months=0,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var string|null */
public ?string $Url=null,
// @DataMember
/** @var string|null */
public ?string $FinalTopic=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Code'])) $this->Code = $o['Code'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Months'])) $this->Months = $o['Months'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Url'])) $this->Url = $o['Url'];
if (isset($o['FinalTopic'])) $this->FinalTopic = $o['FinalTopic'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Code)) $o['Code'] = $this->Code;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Months)) $o['Months'] = $this->Months;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Url)) $o['Url'] = $this->Url;
if (isset($this->FinalTopic)) $o['FinalTopic'] = $this->FinalTopic;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BDeliveryInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var DateTime */
public DateTime $FirstDelivery=new DateTime(),
// @DataMember
/** @var DateTime */
public DateTime $DeliveryTime=new DateTime(),
// @DataMember
/** @var int */
public int $DeliveryThreshold=0,
// @DataMember
/** @var bool|null */
public ?bool $SundayDelivery=null,
// @DataMember
/** @var bool|null */
public ?bool $MondayDelivery=null,
// @DataMember
/** @var bool|null */
public ?bool $TuesdayDelivery=null,
// @DataMember
/** @var bool|null */
public ?bool $WednesdayDelivery=null,
// @DataMember
/** @var bool|null */
public ?bool $ThursdayDelivery=null,
// @DataMember
/** @var bool|null */
public ?bool $FridayDelivery=null,
// @DataMember
/** @var bool|null */
public ?bool $SaturdayDelivery=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FirstDelivery'])) $this->FirstDelivery = JsonConverters::from('DateTime', $o['FirstDelivery']);
if (isset($o['DeliveryTime'])) $this->DeliveryTime = JsonConverters::from('DateTime', $o['DeliveryTime']);
if (isset($o['DeliveryThreshold'])) $this->DeliveryThreshold = $o['DeliveryThreshold'];
if (isset($o['SundayDelivery'])) $this->SundayDelivery = $o['SundayDelivery'];
if (isset($o['MondayDelivery'])) $this->MondayDelivery = $o['MondayDelivery'];
if (isset($o['TuesdayDelivery'])) $this->TuesdayDelivery = $o['TuesdayDelivery'];
if (isset($o['WednesdayDelivery'])) $this->WednesdayDelivery = $o['WednesdayDelivery'];
if (isset($o['ThursdayDelivery'])) $this->ThursdayDelivery = $o['ThursdayDelivery'];
if (isset($o['FridayDelivery'])) $this->FridayDelivery = $o['FridayDelivery'];
if (isset($o['SaturdayDelivery'])) $this->SaturdayDelivery = $o['SaturdayDelivery'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FirstDelivery)) $o['FirstDelivery'] = JsonConverters::to('DateTime', $this->FirstDelivery);
if (isset($this->DeliveryTime)) $o['DeliveryTime'] = JsonConverters::to('DateTime', $this->DeliveryTime);
if (isset($this->DeliveryThreshold)) $o['DeliveryThreshold'] = $this->DeliveryThreshold;
if (isset($this->SundayDelivery)) $o['SundayDelivery'] = $this->SundayDelivery;
if (isset($this->MondayDelivery)) $o['MondayDelivery'] = $this->MondayDelivery;
if (isset($this->TuesdayDelivery)) $o['TuesdayDelivery'] = $this->TuesdayDelivery;
if (isset($this->WednesdayDelivery)) $o['WednesdayDelivery'] = $this->WednesdayDelivery;
if (isset($this->ThursdayDelivery)) $o['ThursdayDelivery'] = $this->ThursdayDelivery;
if (isset($this->FridayDelivery)) $o['FridayDelivery'] = $this->FridayDelivery;
if (isset($this->SaturdayDelivery)) $o['SaturdayDelivery'] = $this->SaturdayDelivery;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BTeacherGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $TeacherName=null,
// @DataMember
/** @var string|null */
public ?string $SchoolName=null,
// @DataMember
/** @var string|null */
public ?string $DistrictName=null,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var C2BDeliveryInfo|null */
public ?C2BDeliveryInfo $DeliveryInfo=null,
// @DataMember
/** @var int|null */
public ?int $AIMSchoolId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TeacherName'])) $this->TeacherName = $o['TeacherName'];
if (isset($o['SchoolName'])) $this->SchoolName = $o['SchoolName'];
if (isset($o['DistrictName'])) $this->DistrictName = $o['DistrictName'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['DeliveryInfo'])) $this->DeliveryInfo = JsonConverters::from('C2BDeliveryInfo', $o['DeliveryInfo']);
if (isset($o['AIMSchoolId'])) $this->AIMSchoolId = $o['AIMSchoolId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TeacherName)) $o['TeacherName'] = $this->TeacherName;
if (isset($this->SchoolName)) $o['SchoolName'] = $this->SchoolName;
if (isset($this->DistrictName)) $o['DistrictName'] = $this->DistrictName;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->DeliveryInfo)) $o['DeliveryInfo'] = JsonConverters::to('C2BDeliveryInfo', $this->DeliveryInfo);
if (isset($this->AIMSchoolId)) $o['AIMSchoolId'] = $this->AIMSchoolId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BSchoolGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $SchoolName=null,
// @DataMember
/** @var string|null */
public ?string $DistrictName=null,
// @DataMember
/** @var int */
public int $TeacherCount=0,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var C2BDeliveryInfo|null */
public ?C2BDeliveryInfo $DeliveryInfo=null,
// @DataMember
/** @var int|null */
public ?int $AIMSchoolId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SchoolName'])) $this->SchoolName = $o['SchoolName'];
if (isset($o['DistrictName'])) $this->DistrictName = $o['DistrictName'];
if (isset($o['TeacherCount'])) $this->TeacherCount = $o['TeacherCount'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['DeliveryInfo'])) $this->DeliveryInfo = JsonConverters::from('C2BDeliveryInfo', $o['DeliveryInfo']);
if (isset($o['AIMSchoolId'])) $this->AIMSchoolId = $o['AIMSchoolId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SchoolName)) $o['SchoolName'] = $this->SchoolName;
if (isset($this->DistrictName)) $o['DistrictName'] = $this->DistrictName;
if (isset($this->TeacherCount)) $o['TeacherCount'] = $this->TeacherCount;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->DeliveryInfo)) $o['DeliveryInfo'] = JsonConverters::to('C2BDeliveryInfo', $this->DeliveryInfo);
if (isset($this->AIMSchoolId)) $o['AIMSchoolId'] = $this->AIMSchoolId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BDistrictGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $DistrictName=null,
// @DataMember
/** @var int */
public int $SchoolCount=0,
// @DataMember
/** @var int */
public int $TeacherCount=0,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DistrictName'])) $this->DistrictName = $o['DistrictName'];
if (isset($o['SchoolCount'])) $this->SchoolCount = $o['SchoolCount'];
if (isset($o['TeacherCount'])) $this->TeacherCount = $o['TeacherCount'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DistrictName)) $o['DistrictName'] = $this->DistrictName;
if (isset($this->SchoolCount)) $o['SchoolCount'] = $this->SchoolCount;
if (isset($this->TeacherCount)) $o['TeacherCount'] = $this->TeacherCount;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BGradeGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Level=0,
// @DataMember
/** @var string|null */
public ?string $Grade=null,
// @DataMember
/** @var float */
public float $DownPay=0.0,
// @DataMember
/** @var float */
public float $DownMaint=0.0,
// @DataMember
/** @var float */
public float $MoPay=0.0,
// @DataMember
/** @var float */
public float $MoMaint=0.0,
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var bool|null */
public ?bool $OutOfStock=null,
// @DataMember
/** @var float */
public float $RentPrice=0.0,
// @DataMember
/** @var float */
public float $CashPrice=0.0,
// @DataMember
/** @var float|null */
public ?float $DownPayTax=null,
// @DataMember
/** @var float|null */
public ?float $DownMaintTax=null,
// @DataMember
/** @var float|null */
public ?float $MoPayTax=null,
// @DataMember
/** @var float|null */
public ?float $MoMaintTax=null,
// @DataMember
/** @var float */
public float $RentPricePlusTax=0.0,
// @DataMember
/** @var float */
public float $RentPricePlusTaxLessDownpay=0.0,
// @DataMember
/** @var int */
public int $Months=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Level'])) $this->Level = $o['Level'];
if (isset($o['Grade'])) $this->Grade = $o['Grade'];
if (isset($o['DownPay'])) $this->DownPay = $o['DownPay'];
if (isset($o['DownMaint'])) $this->DownMaint = $o['DownMaint'];
if (isset($o['MoPay'])) $this->MoPay = $o['MoPay'];
if (isset($o['MoMaint'])) $this->MoMaint = $o['MoMaint'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['OutOfStock'])) $this->OutOfStock = $o['OutOfStock'];
if (isset($o['RentPrice'])) $this->RentPrice = $o['RentPrice'];
if (isset($o['CashPrice'])) $this->CashPrice = $o['CashPrice'];
if (isset($o['DownPayTax'])) $this->DownPayTax = $o['DownPayTax'];
if (isset($o['DownMaintTax'])) $this->DownMaintTax = $o['DownMaintTax'];
if (isset($o['MoPayTax'])) $this->MoPayTax = $o['MoPayTax'];
if (isset($o['MoMaintTax'])) $this->MoMaintTax = $o['MoMaintTax'];
if (isset($o['RentPricePlusTax'])) $this->RentPricePlusTax = $o['RentPricePlusTax'];
if (isset($o['RentPricePlusTaxLessDownpay'])) $this->RentPricePlusTaxLessDownpay = $o['RentPricePlusTaxLessDownpay'];
if (isset($o['Months'])) $this->Months = $o['Months'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Level)) $o['Level'] = $this->Level;
if (isset($this->Grade)) $o['Grade'] = $this->Grade;
if (isset($this->DownPay)) $o['DownPay'] = $this->DownPay;
if (isset($this->DownMaint)) $o['DownMaint'] = $this->DownMaint;
if (isset($this->MoPay)) $o['MoPay'] = $this->MoPay;
if (isset($this->MoMaint)) $o['MoMaint'] = $this->MoMaint;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->OutOfStock)) $o['OutOfStock'] = $this->OutOfStock;
if (isset($this->RentPrice)) $o['RentPrice'] = $this->RentPrice;
if (isset($this->CashPrice)) $o['CashPrice'] = $this->CashPrice;
if (isset($this->DownPayTax)) $o['DownPayTax'] = $this->DownPayTax;
if (isset($this->DownMaintTax)) $o['DownMaintTax'] = $this->DownMaintTax;
if (isset($this->MoPayTax)) $o['MoPayTax'] = $this->MoPayTax;
if (isset($this->MoMaintTax)) $o['MoMaintTax'] = $this->MoMaintTax;
if (isset($this->RentPricePlusTax)) $o['RentPricePlusTax'] = $this->RentPricePlusTax;
if (isset($this->RentPricePlusTaxLessDownpay)) $o['RentPricePlusTaxLessDownpay'] = $this->RentPricePlusTaxLessDownpay;
if (isset($this->Months)) $o['Months'] = $this->Months;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BAccessoryGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $AccessoryDesc=null,
// @DataMember
/** @var float */
public float $Price=0.0,
// @DataMember
/** @var bool|null */
public ?bool $Required=null,
// @DataMember
/** @var bool|null */
public ?bool $Default=null,
// @DataMember
/** @var bool|null */
public ?bool $RequiresLocation=null,
// @DataMember
/** @var string|null */
public ?string $Type=null,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var int */
public int $DisplayOrder=0,
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var float|null */
public ?float $TaxAmount=null,
// @DataMember
/** @var int|null */
public ?int $CatNum=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AccessoryDesc'])) $this->AccessoryDesc = $o['AccessoryDesc'];
if (isset($o['Price'])) $this->Price = $o['Price'];
if (isset($o['Required'])) $this->Required = $o['Required'];
if (isset($o['Default'])) $this->Default = $o['Default'];
if (isset($o['RequiresLocation'])) $this->RequiresLocation = $o['RequiresLocation'];
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['DisplayOrder'])) $this->DisplayOrder = $o['DisplayOrder'];
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['TaxAmount'])) $this->TaxAmount = $o['TaxAmount'];
if (isset($o['CatNum'])) $this->CatNum = $o['CatNum'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AccessoryDesc)) $o['AccessoryDesc'] = $this->AccessoryDesc;
if (isset($this->Price)) $o['Price'] = $this->Price;
if (isset($this->Required)) $o['Required'] = $this->Required;
if (isset($this->Default)) $o['Default'] = $this->Default;
if (isset($this->RequiresLocation)) $o['RequiresLocation'] = $this->RequiresLocation;
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->DisplayOrder)) $o['DisplayOrder'] = $this->DisplayOrder;
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->TaxAmount)) $o['TaxAmount'] = $this->TaxAmount;
if (isset($this->CatNum)) $o['CatNum'] = $this->CatNum;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BInstrumentGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $InstrumentName=null,
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var string|null */
public ?string $Image=null,
// @DataMember
/** @var int */
public int $Level=0,
// @DataMember
/** @var float|null */
public ?float $RentPrice=null,
// @DataMember
/** @var float|null */
public ?float $CashPrice=null,
// @DataMember
/** @var string|null */
public ?string $Token=null,
// @DataMember
/** @var int */
public int $InstrumentId=0,
// @DataMember
/** @var int */
public int $InstrumentTeacherId=0,
// @DataMember
/** @var array<C2BGradeGeneric>|null */
public ?array $GradeList=null,
// @DataMember
/** @var bool|null */
public ?bool $HasGrades=null,
// @DataMember
/** @var int */
public int $DisplayOrder=0,
// @DataMember
/** @var array<C2BAccessoryGeneric>|null */
public ?array $AccessoryList=null,
// @DataMember
/** @var array<C2BAccessoryGeneric>|null */
public ?array $DeliveryList=null,
// @DataMember
/** @var array<C2BAccessoryGeneric>|null */
public ?array $MaintenanceList=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['InstrumentName'])) $this->InstrumentName = $o['InstrumentName'];
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Image'])) $this->Image = $o['Image'];
if (isset($o['Level'])) $this->Level = $o['Level'];
if (isset($o['RentPrice'])) $this->RentPrice = $o['RentPrice'];
if (isset($o['CashPrice'])) $this->CashPrice = $o['CashPrice'];
if (isset($o['Token'])) $this->Token = $o['Token'];
if (isset($o['InstrumentId'])) $this->InstrumentId = $o['InstrumentId'];
if (isset($o['InstrumentTeacherId'])) $this->InstrumentTeacherId = $o['InstrumentTeacherId'];
if (isset($o['GradeList'])) $this->GradeList = JsonConverters::fromArray('C2BGradeGeneric', $o['GradeList']);
if (isset($o['HasGrades'])) $this->HasGrades = $o['HasGrades'];
if (isset($o['DisplayOrder'])) $this->DisplayOrder = $o['DisplayOrder'];
if (isset($o['AccessoryList'])) $this->AccessoryList = JsonConverters::fromArray('C2BAccessoryGeneric', $o['AccessoryList']);
if (isset($o['DeliveryList'])) $this->DeliveryList = JsonConverters::fromArray('C2BAccessoryGeneric', $o['DeliveryList']);
if (isset($o['MaintenanceList'])) $this->MaintenanceList = JsonConverters::fromArray('C2BAccessoryGeneric', $o['MaintenanceList']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->InstrumentName)) $o['InstrumentName'] = $this->InstrumentName;
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Image)) $o['Image'] = $this->Image;
if (isset($this->Level)) $o['Level'] = $this->Level;
if (isset($this->RentPrice)) $o['RentPrice'] = $this->RentPrice;
if (isset($this->CashPrice)) $o['CashPrice'] = $this->CashPrice;
if (isset($this->Token)) $o['Token'] = $this->Token;
if (isset($this->InstrumentId)) $o['InstrumentId'] = $this->InstrumentId;
if (isset($this->InstrumentTeacherId)) $o['InstrumentTeacherId'] = $this->InstrumentTeacherId;
if (isset($this->GradeList)) $o['GradeList'] = JsonConverters::toArray('C2BGradeGeneric', $this->GradeList);
if (isset($this->HasGrades)) $o['HasGrades'] = $this->HasGrades;
if (isset($this->DisplayOrder)) $o['DisplayOrder'] = $this->DisplayOrder;
if (isset($this->AccessoryList)) $o['AccessoryList'] = JsonConverters::toArray('C2BAccessoryGeneric', $this->AccessoryList);
if (isset($this->DeliveryList)) $o['DeliveryList'] = JsonConverters::toArray('C2BAccessoryGeneric', $this->DeliveryList);
if (isset($this->MaintenanceList)) $o['MaintenanceList'] = JsonConverters::toArray('C2BAccessoryGeneric', $this->MaintenanceList);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BInstrumentDetailGeneric implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var C2BPlanCodeGeneric|null */
public ?C2BPlanCodeGeneric $PlanCode=null,
// @DataMember
/** @var C2BTeacherGeneric|null */
public ?C2BTeacherGeneric $Teacher=null,
// @DataMember
/** @var C2BSchoolGeneric|null */
public ?C2BSchoolGeneric $School=null,
// @DataMember
/** @var string|null */
public ?string $DeliveryDate=null,
// @DataMember
/** @var string|null */
public ?string $SalesPerson=null,
// @DataMember
/** @var C2BDistrictGeneric|null */
public ?C2BDistrictGeneric $District=null,
// @DataMember
/** @var C2BInstrumentGeneric|null */
public ?C2BInstrumentGeneric $Instrument=null,
// @DataMember
/** @var C2BGradeGeneric|null */
public ?C2BGradeGeneric $Grade=null,
// @DataMember
/** @var array<C2BAccessoryGeneric>|null */
public ?array $AccessoryList=null,
// @DataMember
/** @var array<C2BAccessoryGeneric>|null */
public ?array $DeliveryList=null,
// @DataMember
/** @var array<C2BAccessoryGeneric>|null */
public ?array $MaintenanceList=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PlanCode'])) $this->PlanCode = JsonConverters::from('C2BPlanCodeGeneric', $o['PlanCode']);
if (isset($o['Teacher'])) $this->Teacher = JsonConverters::from('C2BTeacherGeneric', $o['Teacher']);
if (isset($o['School'])) $this->School = JsonConverters::from('C2BSchoolGeneric', $o['School']);
if (isset($o['DeliveryDate'])) $this->DeliveryDate = $o['DeliveryDate'];
if (isset($o['SalesPerson'])) $this->SalesPerson = $o['SalesPerson'];
if (isset($o['District'])) $this->District = JsonConverters::from('C2BDistrictGeneric', $o['District']);
if (isset($o['Instrument'])) $this->Instrument = JsonConverters::from('C2BInstrumentGeneric', $o['Instrument']);
if (isset($o['Grade'])) $this->Grade = JsonConverters::from('C2BGradeGeneric', $o['Grade']);
if (isset($o['AccessoryList'])) $this->AccessoryList = JsonConverters::fromArray('C2BAccessoryGeneric', $o['AccessoryList']);
if (isset($o['DeliveryList'])) $this->DeliveryList = JsonConverters::fromArray('C2BAccessoryGeneric', $o['DeliveryList']);
if (isset($o['MaintenanceList'])) $this->MaintenanceList = JsonConverters::fromArray('C2BAccessoryGeneric', $o['MaintenanceList']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PlanCode)) $o['PlanCode'] = JsonConverters::to('C2BPlanCodeGeneric', $this->PlanCode);
if (isset($this->Teacher)) $o['Teacher'] = JsonConverters::to('C2BTeacherGeneric', $this->Teacher);
if (isset($this->School)) $o['School'] = JsonConverters::to('C2BSchoolGeneric', $this->School);
if (isset($this->DeliveryDate)) $o['DeliveryDate'] = $this->DeliveryDate;
if (isset($this->SalesPerson)) $o['SalesPerson'] = $this->SalesPerson;
if (isset($this->District)) $o['District'] = JsonConverters::to('C2BDistrictGeneric', $this->District);
if (isset($this->Instrument)) $o['Instrument'] = JsonConverters::to('C2BInstrumentGeneric', $this->Instrument);
if (isset($this->Grade)) $o['Grade'] = JsonConverters::to('C2BGradeGeneric', $this->Grade);
if (isset($this->AccessoryList)) $o['AccessoryList'] = JsonConverters::toArray('C2BAccessoryGeneric', $this->AccessoryList);
if (isset($this->DeliveryList)) $o['DeliveryList'] = JsonConverters::toArray('C2BAccessoryGeneric', $this->DeliveryList);
if (isset($this->MaintenanceList)) $o['MaintenanceList'] = JsonConverters::toArray('C2BAccessoryGeneric', $this->MaintenanceList);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class MobileLayout implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $title=null,
// @DataMember
/** @var string|null */
public ?string $returnurl=null,
// @DataMember
/** @var Section[]|null */
public ?array $sections=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['returnurl'])) $this->returnurl = $o['returnurl'];
if (isset($o['sections'])) $this->sections = JsonConverters::fromArray('Section', $o['sections']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->returnurl)) $o['returnurl'] = $this->returnurl;
if (isset($this->sections)) $o['sections'] = JsonConverters::toArray('Section', $this->sections);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class C2BGetInstrumentDetailResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var C2BInstrumentDetailGeneric|null */
public ?C2BInstrumentDetailGeneric $InstrumentDetails=null,
// @DataMember
/** @var MobileLayout|null */
public ?MobileLayout $MobileLayout=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['InstrumentDetails'])) $this->InstrumentDetails = JsonConverters::from('C2BInstrumentDetailGeneric', $o['InstrumentDetails']);
if (isset($o['MobileLayout'])) $this->MobileLayout = JsonConverters::from('MobileLayout', $o['MobileLayout']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->InstrumentDetails)) $o['InstrumentDetails'] = JsonConverters::to('C2BInstrumentDetailGeneric', $this->InstrumentDetails);
if (isset($this->MobileLayout)) $o['MobileLayout'] = JsonConverters::to('MobileLayout', $this->MobileLayout);
return empty($o) ? new class(){} : $o;
}
}
/** @description C2BGetInstrumentDetailRequires active-e Contracts Service. */
// @DataContract
class C2BGetInstrumentDetailRequest 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='',
/** @description ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent. */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.", Format="int64", Name="RsiPk", ParameterType="query")
/** @var int|null */
public ?int $RsiPk=null,
/** @description ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent. */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.", Format="int64", Name="TeacherId", ParameterType="query")
/** @var int|null */
public ?int $TeacherId=null,
/** @description ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent. */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.", Format="int64", Name="InstrumentId", ParameterType="query")
/** @var int|null */
public ?int $InstrumentId=null,
/** @description ID of the Rate to be used. This is required. */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the Rate to be used. This is required.", Format="int64", IsRequired=true, Name="RateId", ParameterType="query")
/** @var int */
public int $RateId=0,
/** @description If 'Y', then Mobile Layout will be returned. */
// @DataMember
// @ApiMember(DataType="string", Description="If 'Y', then Mobile Layout will be returned.", Name="IncludeMobileLayout", ParameterType="query")
/** @var string|null */
public ?string $IncludeMobileLayout=null,
/** @description ID of the Delivery option to be used. */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the Delivery option to be used.", Format="int64", IsRequired=true, Name="DeliveryId", ParameterType="query")
/** @var int */
public int $DeliveryId=0,
/** @description ID of the Location. Used for Location required Delivery options. */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the Location. Used for Location required Delivery options.", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
/** @var int */
public int $LocationId=0
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['RsiPk'])) $this->RsiPk = $o['RsiPk'];
if (isset($o['TeacherId'])) $this->TeacherId = $o['TeacherId'];
if (isset($o['InstrumentId'])) $this->InstrumentId = $o['InstrumentId'];
if (isset($o['RateId'])) $this->RateId = $o['RateId'];
if (isset($o['IncludeMobileLayout'])) $this->IncludeMobileLayout = $o['IncludeMobileLayout'];
if (isset($o['DeliveryId'])) $this->DeliveryId = $o['DeliveryId'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->RsiPk)) $o['RsiPk'] = $this->RsiPk;
if (isset($this->TeacherId)) $o['TeacherId'] = $this->TeacherId;
if (isset($this->InstrumentId)) $o['InstrumentId'] = $this->InstrumentId;
if (isset($this->RateId)) $o['RateId'] = $this->RateId;
if (isset($this->IncludeMobileLayout)) $o['IncludeMobileLayout'] = $this->IncludeMobileLayout;
if (isset($this->DeliveryId)) $o['DeliveryId'] = $this->DeliveryId;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class Section implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $header=null,
// @DataMember
/** @var string|null */
public ?string $id=null,
// @DataMember
/** @var string|null */
public ?string $margin=null,
// @DataMember
/** @var Element[]|null */
public ?array $elements=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['header'])) $this->header = $o['header'];
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['margin'])) $this->margin = $o['margin'];
if (isset($o['elements'])) $this->elements = JsonConverters::fromArray('Element', $o['elements']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->header)) $o['header'] = $this->header;
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->margin)) $o['margin'] = $this->margin;
if (isset($this->elements)) $o['elements'] = JsonConverters::toArray('Element', $this->elements);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class LicenseMap implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $name=null,
// @DataMember
/** @var string|null */
public ?string $value=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['value'])) $this->value = $o['value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->value)) $o['value'] = $this->value;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class Element implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $type=null,
// @DataMember
/** @var string|null */
public ?string $label=null,
// @DataMember
/** @var string|null */
public ?string $id=null,
// @DataMember
/** @var string|null */
public ?string $fontsize=null,
// @DataMember
/** @var string|null */
public ?string $margin=null,
// @DataMember
/** @var string|null */
public ?string $backgroundcolor=null,
// @DataMember
/** @var string|null */
public ?string $textcolor=null,
// @DataMember
/** @var string|null */
public ?string $height=null,
// @DataMember
/** @var string|null */
public ?string $width=null,
// @DataMember
/** @var string|null */
public ?string $value=null,
// @DataMember
/** @var bool|null */
public ?bool $addvalue=null,
// @DataMember
/** @var string[]|null */
public ?array $values=null,
// @DataMember
/** @var string|null */
public ?string $textalign=null,
// @DataMember
/** @var bool|null */
public ?bool $required=null,
// @DataMember
/** @var string|null */
public ?string $placeholder=null,
// @DataMember
/** @var bool|null */
public ?bool $fontbold=null,
// @DataMember
/** @var bool|null */
public ?bool $selected=null,
// @DataMember
/** @var bool|null */
public ?bool $disabled=null,
// @DataMember
/** @var bool|null */
public ?bool $totalamount=null,
// @DataMember
/** @var array<Element>|null */
public ?array $elements=null,
// @DataMember
/** @var array<LicenseMap>|null */
public ?array $map=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['type'])) $this->type = $o['type'];
if (isset($o['label'])) $this->label = $o['label'];
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['fontsize'])) $this->fontsize = $o['fontsize'];
if (isset($o['margin'])) $this->margin = $o['margin'];
if (isset($o['backgroundcolor'])) $this->backgroundcolor = $o['backgroundcolor'];
if (isset($o['textcolor'])) $this->textcolor = $o['textcolor'];
if (isset($o['height'])) $this->height = $o['height'];
if (isset($o['width'])) $this->width = $o['width'];
if (isset($o['value'])) $this->value = $o['value'];
if (isset($o['addvalue'])) $this->addvalue = $o['addvalue'];
if (isset($o['values'])) $this->values = JsonConverters::fromArray('string', $o['values']);
if (isset($o['textalign'])) $this->textalign = $o['textalign'];
if (isset($o['required'])) $this->required = $o['required'];
if (isset($o['placeholder'])) $this->placeholder = $o['placeholder'];
if (isset($o['fontbold'])) $this->fontbold = $o['fontbold'];
if (isset($o['selected'])) $this->selected = $o['selected'];
if (isset($o['disabled'])) $this->disabled = $o['disabled'];
if (isset($o['totalamount'])) $this->totalamount = $o['totalamount'];
if (isset($o['elements'])) $this->elements = JsonConverters::fromArray('Element', $o['elements']);
if (isset($o['map'])) $this->map = JsonConverters::fromArray('LicenseMap', $o['map']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->type)) $o['type'] = $this->type;
if (isset($this->label)) $o['label'] = $this->label;
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->fontsize)) $o['fontsize'] = $this->fontsize;
if (isset($this->margin)) $o['margin'] = $this->margin;
if (isset($this->backgroundcolor)) $o['backgroundcolor'] = $this->backgroundcolor;
if (isset($this->textcolor)) $o['textcolor'] = $this->textcolor;
if (isset($this->height)) $o['height'] = $this->height;
if (isset($this->width)) $o['width'] = $this->width;
if (isset($this->value)) $o['value'] = $this->value;
if (isset($this->addvalue)) $o['addvalue'] = $this->addvalue;
if (isset($this->values)) $o['values'] = JsonConverters::toArray('string', $this->values);
if (isset($this->textalign)) $o['textalign'] = $this->textalign;
if (isset($this->required)) $o['required'] = $this->required;
if (isset($this->placeholder)) $o['placeholder'] = $this->placeholder;
if (isset($this->fontbold)) $o['fontbold'] = $this->fontbold;
if (isset($this->selected)) $o['selected'] = $this->selected;
if (isset($this->disabled)) $o['disabled'] = $this->disabled;
if (isset($this->totalamount)) $o['totalamount'] = $this->totalamount;
if (isset($this->elements)) $o['elements'] = JsonConverters::toArray('Element', $this->elements);
if (isset($this->map)) $o['map'] = JsonConverters::toArray('LicenseMap', $this->map);
return empty($o) ? new class(){} : $o;
}
}
PHP C2BGetInstrumentDetailRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/C2BGetInstrumentDetail HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"RsiPk":0,"TeacherId":0,"InstrumentId":0,"RateId":0,"IncludeMobileLayout":"String","DeliveryId":0,"LocationId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"MobileLayout":{"title":"String","returnurl":"String","sections":[{"header":"String","id":"String","margin":"String","elements":[{"type":"String","label":"String","id":"String","fontsize":"String","margin":"String","backgroundcolor":"String","textcolor":"String","height":"String","width":"String","value":"String","addvalue":false,"values":["String"],"textalign":"String","required":false,"placeholder":"String","fontbold":false,"selected":false,"disabled":false,"totalamount":false}]}]},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}