| GET | /api/SaleInfo |
|---|
<?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 DiscountFromPriceLevel implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $BasePriceLevel=null,
// @DataMember
/** @var float */
public float $DisountPercentage=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BasePriceLevel'])) $this->BasePriceLevel = $o['BasePriceLevel'];
if (isset($o['DisountPercentage'])) $this->DisountPercentage = $o['DisountPercentage'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BasePriceLevel)) $o['BasePriceLevel'] = $this->BasePriceLevel;
if (isset($this->DisountPercentage)) $o['DisountPercentage'] = $this->DisountPercentage;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class RecurringSaleDay implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Weekday=null,
// @DataMember
/** @var int */
public int $BeginHour=0,
// @DataMember
/** @var int */
public int $BeginMinute=0,
// @DataMember
/** @var int */
public int $EndHour=0,
// @DataMember
/** @var int */
public int $EndMinute=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Weekday'])) $this->Weekday = $o['Weekday'];
if (isset($o['BeginHour'])) $this->BeginHour = $o['BeginHour'];
if (isset($o['BeginMinute'])) $this->BeginMinute = $o['BeginMinute'];
if (isset($o['EndHour'])) $this->EndHour = $o['EndHour'];
if (isset($o['EndMinute'])) $this->EndMinute = $o['EndMinute'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Weekday)) $o['Weekday'] = $this->Weekday;
if (isset($this->BeginHour)) $o['BeginHour'] = $this->BeginHour;
if (isset($this->BeginMinute)) $o['BeginMinute'] = $this->BeginMinute;
if (isset($this->EndHour)) $o['EndHour'] = $this->EndHour;
if (isset($this->EndMinute)) $o['EndMinute'] = $this->EndMinute;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class RecurringSaleInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var array<RecurringSaleDay>|null */
public ?array $Days=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Days'])) $this->Days = JsonConverters::fromArray('RecurringSaleDay', $o['Days']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Days)) $o['Days'] = JsonConverters::toArray('RecurringSaleDay', $this->Days);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class SaleRecord implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $SadPk=0,
// @DataMember
/** @var int */
public int $SkuPk=0,
// @DataMember
/** @var int */
public int $SaqPk=0,
// @DataMember
/** @var string|null */
public ?string $Model=null,
// @DataMember
/** @var string|null */
public ?string $SKU=null,
// @DataMember
/** @var int */
public int $LocationId=0,
// @DataMember
/** @var DateTime */
public DateTime $StartDate=new DateTime(),
// @DataMember
/** @var DateTime */
public DateTime $EndDate=new DateTime(),
// @DataMember
/** @var int|null */
public ?int $CustomerAccount=null,
// @DataMember
/** @var int|null */
public ?int $CustomerDefaultId=null,
// @DataMember
/** @var string|null */
public ?string $Condition=null,
// @DataMember
/** @var DiscountFromPriceLevel|null */
public ?DiscountFromPriceLevel $DiscountFromPriceLevel=null,
// @DataMember
/** @var string|null */
public ?string $DiscountByPriceLevel=null,
// @DataMember
/** @var float|null */
public ?float $DiscountBySetPrice=null,
// @DataMember
/** @var float|null */
public ?float $DiscountByAmount=null,
// @DataMember
/** @var RecurringSaleInfo|null */
public ?RecurringSaleInfo $RecurringSale=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SadPk'])) $this->SadPk = $o['SadPk'];
if (isset($o['SkuPk'])) $this->SkuPk = $o['SkuPk'];
if (isset($o['SaqPk'])) $this->SaqPk = $o['SaqPk'];
if (isset($o['Model'])) $this->Model = $o['Model'];
if (isset($o['SKU'])) $this->SKU = $o['SKU'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
if (isset($o['CustomerAccount'])) $this->CustomerAccount = $o['CustomerAccount'];
if (isset($o['CustomerDefaultId'])) $this->CustomerDefaultId = $o['CustomerDefaultId'];
if (isset($o['Condition'])) $this->Condition = $o['Condition'];
if (isset($o['DiscountFromPriceLevel'])) $this->DiscountFromPriceLevel = JsonConverters::from('DiscountFromPriceLevel', $o['DiscountFromPriceLevel']);
if (isset($o['DiscountByPriceLevel'])) $this->DiscountByPriceLevel = $o['DiscountByPriceLevel'];
if (isset($o['DiscountBySetPrice'])) $this->DiscountBySetPrice = $o['DiscountBySetPrice'];
if (isset($o['DiscountByAmount'])) $this->DiscountByAmount = $o['DiscountByAmount'];
if (isset($o['RecurringSale'])) $this->RecurringSale = JsonConverters::from('RecurringSaleInfo', $o['RecurringSale']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SadPk)) $o['SadPk'] = $this->SadPk;
if (isset($this->SkuPk)) $o['SkuPk'] = $this->SkuPk;
if (isset($this->SaqPk)) $o['SaqPk'] = $this->SaqPk;
if (isset($this->Model)) $o['Model'] = $this->Model;
if (isset($this->SKU)) $o['SKU'] = $this->SKU;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
if (isset($this->CustomerAccount)) $o['CustomerAccount'] = $this->CustomerAccount;
if (isset($this->CustomerDefaultId)) $o['CustomerDefaultId'] = $this->CustomerDefaultId;
if (isset($this->Condition)) $o['Condition'] = $this->Condition;
if (isset($this->DiscountFromPriceLevel)) $o['DiscountFromPriceLevel'] = JsonConverters::to('DiscountFromPriceLevel', $this->DiscountFromPriceLevel);
if (isset($this->DiscountByPriceLevel)) $o['DiscountByPriceLevel'] = $this->DiscountByPriceLevel;
if (isset($this->DiscountBySetPrice)) $o['DiscountBySetPrice'] = $this->DiscountBySetPrice;
if (isset($this->DiscountByAmount)) $o['DiscountByAmount'] = $this->DiscountByAmount;
if (isset($this->RecurringSale)) $o['RecurringSale'] = JsonConverters::to('RecurringSaleInfo', $this->RecurringSale);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class SaleInfoResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<SaleRecord>|null */
public ?array $SaleRecords=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['SaleRecords'])) $this->SaleRecords = JsonConverters::fromArray('SaleRecord', $o['SaleRecords']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->SaleRecords)) $o['SaleRecords'] = JsonConverters::toArray('SaleRecord', $this->SaleRecords);
return empty($o) ? new class(){} : $o;
}
}
/** @description SaleInfoRequires active-e Inventory Service */
// @DataContract
class SaleInfoRequest 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|null */
public ?int $LocationId=null,
/** @description If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used */
// @DataMember
// @ApiMember(Description="If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used", Name="DateTime")
/** @var DateTime|null */
public ?DateTime $DateTime=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['DateTime'])) $this->DateTime = JsonConverters::from('DateTime', $o['DateTime']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->DateTime)) $o['DateTime'] = JsonConverters::to('DateTime', $this->DateTime);
return empty($o) ? new class(){} : $o;
}
}
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.
GET /api/SaleInfo HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"SaleRecords":[{"SadPk":0,"SkuPk":0,"SaqPk":0,"Model":"String","SKU":"String","LocationId":0,"CustomerAccount":0,"CustomerDefaultId":0,"Condition":"String","DiscountFromPriceLevel":{"BasePriceLevel":"String","DisountPercentage":0},"DiscountByPriceLevel":"String","DiscountBySetPrice":0,"DiscountByAmount":0,"RecurringSale":{"Days":[{"Weekday":"String","BeginHour":0,"BeginMinute":0,"EndHour":0,"EndMinute":0}]}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}