| POST | /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 ScheduledExchangesPostResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var int|null */
public ?int $ExchangeID=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ExchangeID'])) $this->ExchangeID = $o['ExchangeID'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ExchangeID)) $o['ExchangeID'] = $this->ExchangeID;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="FormInput")
class FormInput implements JsonSerializable
{
public function __construct(
/** @description Field Name of the Input Field */
// @DataMember
// @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
/** @var string */
public string $Key='',
/** @description Value of the Input Field. */
// @DataMember
// @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
/** @var string */
public string $Value='',
/** @description Whether or not the field is encryped with the C2B encryption key. */
// @DataMember
// @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
/** @var bool|null */
public ?bool $Encrypted=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Value'])) $this->Value = $o['Value'];
if (isset($o['Encrypted'])) $this->Encrypted = $o['Encrypted'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Value)) $o['Value'] = $this->Value;
if (isset($this->Encrypted)) $o['Encrypted'] = $this->Encrypted;
return empty($o) ? new class(){} : $o;
}
}
/** @description ScheduledExchangesRequires active-e Contracts Service. */
// @DataContract
class ScheduledExchangesPostRequest extends BaseSecureRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
* @param string|null $Token
* @param string|null $DeviceId
* @param string $AppId
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
?string $Token=null,
?string $DeviceId=null,
string $AppId='',
// @DataMember
/** @var int */
public int $Acct=0,
// @DataMember
/** @var int */
public int $Sub=0,
// @DataMember
/** @var int */
public int $ExchangedItemID=0,
// @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 int|null */
public ?int $OptionId=null,
// @DataMember
/** @var string|null */
public ?string $ExchangeNotes=null,
// @DataMember
/** @var bool|null */
public ?bool $Processed=null,
// @DataMember
/** @var int|null */
public ?int $StatusId=null,
/** @description Key/Value pair only. The 'Encrypted' proprety is not used for this API call. */
// @DataMember
// @ApiMember(DataType="array", Description="Key/Value pair only. The 'Encrypted' proprety is not used for this API call.", Name="FormInputList", ParameterType="query")
/** @var array<FormInput>|null */
public ?array $FormInputList=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['Sub'])) $this->Sub = $o['Sub'];
if (isset($o['ExchangedItemID'])) $this->ExchangedItemID = $o['ExchangedItemID'];
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['OptionId'])) $this->OptionId = $o['OptionId'];
if (isset($o['ExchangeNotes'])) $this->ExchangeNotes = $o['ExchangeNotes'];
if (isset($o['Processed'])) $this->Processed = $o['Processed'];
if (isset($o['StatusId'])) $this->StatusId = $o['StatusId'];
if (isset($o['FormInputList'])) $this->FormInputList = JsonConverters::fromArray('FormInput', $o['FormInputList']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->Sub)) $o['Sub'] = $this->Sub;
if (isset($this->ExchangedItemID)) $o['ExchangedItemID'] = $this->ExchangedItemID;
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->OptionId)) $o['OptionId'] = $this->OptionId;
if (isset($this->ExchangeNotes)) $o['ExchangeNotes'] = $this->ExchangeNotes;
if (isset($this->Processed)) $o['Processed'] = $this->Processed;
if (isset($this->StatusId)) $o['StatusId'] = $this->StatusId;
if (isset($this->FormInputList)) $o['FormInputList'] = JsonConverters::toArray('FormInput', $this->FormInputList);
return empty($o) ? new class(){} : $o;
}
}
PHP ScheduledExchangesPostRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/ScheduledExchanges HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ScheduledExchangesPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<Acct>0</Acct>
<ExchangeNotes>String</ExchangeNotes>
<ExchangedItemID>0</ExchangedItemID>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<NewSku>String</NewSku>
<OptionId>0</OptionId>
<PostingDate>0001-01-01T00:00:00</PostingDate>
<Processed>false</Processed>
<ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
<StatusId>0</StatusId>
<Sub>0</Sub>
</ScheduledExchangesPostRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ScheduledExchangesPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<ExchangeID>0</ExchangeID>
</ScheduledExchangesPostResponse>