| GET | /api/ScheduledExchanges |
|---|
<?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 ScheduledExchangesGetInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $ExchangeID=0,
// @DataMember
/** @var int */
public int $Acct=0,
// @DataMember
/** @var int */
public int $Sub=0,
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $Address=null,
// @DataMember
/** @var string|null */
public ?string $Address2=null,
// @DataMember
/** @var string|null */
public ?string $City=null,
// @DataMember
/** @var string|null */
public ?string $Student=null,
// @DataMember
/** @var string|null */
public ?string $School=null,
// @DataMember
/** @var string|null */
public ?string $District=null,
// @DataMember
/** @var string|null */
public ?string $Item=null,
// @DataMember
/** @var string|null */
public ?string $Employee=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $ReturnedDate=null,
// @DataMember
/** @var string|null */
public ?string $StockNumber=null,
// @DataMember
/** @var string|null */
public ?string $Serial=null,
// @DataMember
/** @var string|null */
public ?string $ReturnOption=null,
// @DataMember
/** @var string|null */
public ?string $ScheduledReturnedRef=null,
// @DataMember
/** @var string|null */
public ?string $Status=null,
// @DataMember
/** @var string|null */
public ?string $History=null,
// @DataMember
/** @var int|null */
public ?int $ExchangeRef=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $AutoPayHoldDate=null,
// @DataMember
/** @var string|null */
public ?string $ExchangedItem=null,
// @DataMember
/** @var DateTime */
public DateTime $PostingDate=new DateTime(),
// @DataMember
/** @var DateTime */
public DateTime $ScheduledDate=new DateTime(),
// @DataMember
/** @var string|null */
public ?string $NewSku=null,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var string|null */
public ?string $Source=null,
// @DataMember
/** @var string|null */
public ?string $Option=null,
// @DataMember
/** @var bool|null */
public ?bool $Processed=null,
// @DataMember
/** @var bool|null */
public ?bool $MobileExchangedStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ExchangeID'])) $this->ExchangeID = $o['ExchangeID'];
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['Sub'])) $this->Sub = $o['Sub'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Address'])) $this->Address = $o['Address'];
if (isset($o['Address2'])) $this->Address2 = $o['Address2'];
if (isset($o['City'])) $this->City = $o['City'];
if (isset($o['Student'])) $this->Student = $o['Student'];
if (isset($o['School'])) $this->School = $o['School'];
if (isset($o['District'])) $this->District = $o['District'];
if (isset($o['Item'])) $this->Item = $o['Item'];
if (isset($o['Employee'])) $this->Employee = $o['Employee'];
if (isset($o['ReturnedDate'])) $this->ReturnedDate = JsonConverters::from('DateTime', $o['ReturnedDate']);
if (isset($o['StockNumber'])) $this->StockNumber = $o['StockNumber'];
if (isset($o['Serial'])) $this->Serial = $o['Serial'];
if (isset($o['ReturnOption'])) $this->ReturnOption = $o['ReturnOption'];
if (isset($o['ScheduledReturnedRef'])) $this->ScheduledReturnedRef = $o['ScheduledReturnedRef'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['History'])) $this->History = $o['History'];
if (isset($o['ExchangeRef'])) $this->ExchangeRef = $o['ExchangeRef'];
if (isset($o['AutoPayHoldDate'])) $this->AutoPayHoldDate = JsonConverters::from('DateTime', $o['AutoPayHoldDate']);
if (isset($o['ExchangedItem'])) $this->ExchangedItem = $o['ExchangedItem'];
if (isset($o['PostingDate'])) $this->PostingDate = JsonConverters::from('DateTime', $o['PostingDate']);
if (isset($o['ScheduledDate'])) $this->ScheduledDate = JsonConverters::from('DateTime', $o['ScheduledDate']);
if (isset($o['NewSku'])) $this->NewSku = $o['NewSku'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['Source'])) $this->Source = $o['Source'];
if (isset($o['Option'])) $this->Option = $o['Option'];
if (isset($o['Processed'])) $this->Processed = $o['Processed'];
if (isset($o['MobileExchangedStatus'])) $this->MobileExchangedStatus = $o['MobileExchangedStatus'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ExchangeID)) $o['ExchangeID'] = $this->ExchangeID;
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->Sub)) $o['Sub'] = $this->Sub;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Address)) $o['Address'] = $this->Address;
if (isset($this->Address2)) $o['Address2'] = $this->Address2;
if (isset($this->City)) $o['City'] = $this->City;
if (isset($this->Student)) $o['Student'] = $this->Student;
if (isset($this->School)) $o['School'] = $this->School;
if (isset($this->District)) $o['District'] = $this->District;
if (isset($this->Item)) $o['Item'] = $this->Item;
if (isset($this->Employee)) $o['Employee'] = $this->Employee;
if (isset($this->ReturnedDate)) $o['ReturnedDate'] = JsonConverters::to('DateTime', $this->ReturnedDate);
if (isset($this->StockNumber)) $o['StockNumber'] = $this->StockNumber;
if (isset($this->Serial)) $o['Serial'] = $this->Serial;
if (isset($this->ReturnOption)) $o['ReturnOption'] = $this->ReturnOption;
if (isset($this->ScheduledReturnedRef)) $o['ScheduledReturnedRef'] = $this->ScheduledReturnedRef;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->History)) $o['History'] = $this->History;
if (isset($this->ExchangeRef)) $o['ExchangeRef'] = $this->ExchangeRef;
if (isset($this->AutoPayHoldDate)) $o['AutoPayHoldDate'] = JsonConverters::to('DateTime', $this->AutoPayHoldDate);
if (isset($this->ExchangedItem)) $o['ExchangedItem'] = $this->ExchangedItem;
if (isset($this->PostingDate)) $o['PostingDate'] = JsonConverters::to('DateTime', $this->PostingDate);
if (isset($this->ScheduledDate)) $o['ScheduledDate'] = JsonConverters::to('DateTime', $this->ScheduledDate);
if (isset($this->NewSku)) $o['NewSku'] = $this->NewSku;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->Source)) $o['Source'] = $this->Source;
if (isset($this->Option)) $o['Option'] = $this->Option;
if (isset($this->Processed)) $o['Processed'] = $this->Processed;
if (isset($this->MobileExchangedStatus)) $o['MobileExchangedStatus'] = $this->MobileExchangedStatus;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ScheduledExchangesGetResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<ScheduledExchangesGetInfo>|null */
public ?array $ScheduledExchanges=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ScheduledExchanges'])) $this->ScheduledExchanges = JsonConverters::fromArray('ScheduledExchangesGetInfo', $o['ScheduledExchanges']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ScheduledExchanges)) $o['ScheduledExchanges'] = JsonConverters::toArray('ScheduledExchangesGetInfo', $this->ScheduledExchanges);
return empty($o) ? new class(){} : $o;
}
}
/** @description ScheduledExchangesRequires active-e Contracts Service. */
// @DataContract
class ScheduledExchangesGetRequest 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 DateTime|null */
public ?DateTime $ScheduledDateFrom=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $ScheduledDateTo=null,
// @DataMember
/** @var int|null */
public ?int $DistrictId=null,
// @DataMember
/** @var int|null */
public ?int $SchoolId=null,
// @DataMember
/** @var int|null */
public ?int $LocationId=null,
// @DataMember
/** @var int|null */
public ?int $StatusId=null,
// @DataMember
/** @var int|null */
public ?int $OptionId=null,
// @DataMember
/** @var bool|null */
public ?bool $IncludeProcessed=null,
// @DataMember
/** @var string|null */
public ?string $LanId=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ScheduledDateFrom'])) $this->ScheduledDateFrom = JsonConverters::from('DateTime', $o['ScheduledDateFrom']);
if (isset($o['ScheduledDateTo'])) $this->ScheduledDateTo = JsonConverters::from('DateTime', $o['ScheduledDateTo']);
if (isset($o['DistrictId'])) $this->DistrictId = $o['DistrictId'];
if (isset($o['SchoolId'])) $this->SchoolId = $o['SchoolId'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['StatusId'])) $this->StatusId = $o['StatusId'];
if (isset($o['OptionId'])) $this->OptionId = $o['OptionId'];
if (isset($o['IncludeProcessed'])) $this->IncludeProcessed = $o['IncludeProcessed'];
if (isset($o['LanId'])) $this->LanId = $o['LanId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ScheduledDateFrom)) $o['ScheduledDateFrom'] = JsonConverters::to('DateTime', $this->ScheduledDateFrom);
if (isset($this->ScheduledDateTo)) $o['ScheduledDateTo'] = JsonConverters::to('DateTime', $this->ScheduledDateTo);
if (isset($this->DistrictId)) $o['DistrictId'] = $this->DistrictId;
if (isset($this->SchoolId)) $o['SchoolId'] = $this->SchoolId;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->StatusId)) $o['StatusId'] = $this->StatusId;
if (isset($this->OptionId)) $o['OptionId'] = $this->OptionId;
if (isset($this->IncludeProcessed)) $o['IncludeProcessed'] = $this->IncludeProcessed;
if (isset($this->LanId)) $o['LanId'] = $this->LanId;
return empty($o) ? new class(){} : $o;
}
}
PHP ScheduledExchangesGetRequest 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.
GET /api/ScheduledExchanges HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ScheduledExchanges":[{"ExchangeID":0,"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","History":"String","ExchangeRef":0,"AutoPayHoldDate":"0001-01-01T00:00:00.0000000","ExchangedItem":"String","NewSku":"String","Notes":"String","Source":"String","Option":"String","Processed":false,"MobileExchangedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}