| GET | /api/CategoryListing |
|---|
<?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 SubCategoryAttributeInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $AttributeName=null,
// @DataMember
/** @var int */
public int $Priority=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AttributeName'])) $this->AttributeName = $o['AttributeName'];
if (isset($o['Priority'])) $this->Priority = $o['Priority'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AttributeName)) $o['AttributeName'] = $this->AttributeName;
if (isset($this->Priority)) $o['Priority'] = $this->Priority;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class SubCategoryInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $SubNumber=0,
// @DataMember
/** @var string|null */
public ?string $Description=null,
// @DataMember
/** @var bool|null */
public ?bool $Active=null,
// @DataMember
/** @var float */
public float $Price=0.0,
// @DataMember
/** @var array<SubCategoryAttributeInfo>|null */
public ?array $SkuAttributes=null,
// @DataMember
/** @var array<SubCategoryAttributeInfo>|null */
public ?array $SerialAttributes=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SubNumber'])) $this->SubNumber = $o['SubNumber'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['Price'])) $this->Price = $o['Price'];
if (isset($o['SkuAttributes'])) $this->SkuAttributes = JsonConverters::fromArray('SubCategoryAttributeInfo', $o['SkuAttributes']);
if (isset($o['SerialAttributes'])) $this->SerialAttributes = JsonConverters::fromArray('SubCategoryAttributeInfo', $o['SerialAttributes']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SubNumber)) $o['SubNumber'] = $this->SubNumber;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->Price)) $o['Price'] = $this->Price;
if (isset($this->SkuAttributes)) $o['SkuAttributes'] = JsonConverters::toArray('SubCategoryAttributeInfo', $this->SkuAttributes);
if (isset($this->SerialAttributes)) $o['SerialAttributes'] = JsonConverters::toArray('SubCategoryAttributeInfo', $this->SerialAttributes);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class CategoryInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $CategoryNumber=0,
// @DataMember
/** @var string|null */
public ?string $CategoryType=null,
// @DataMember
/** @var string|null */
public ?string $Description=null,
// @DataMember
/** @var bool|null */
public ?bool $Active=null,
// @DataMember
/** @var array<SubCategoryInfo>|null */
public ?array $SubCategoryListing=null,
// @DataMember
/** @var string|null */
public ?string $PaymentCategoryType=null,
// @DataMember
/** @var bool|null */
public ?bool $AllowedOnMobile=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CategoryNumber'])) $this->CategoryNumber = $o['CategoryNumber'];
if (isset($o['CategoryType'])) $this->CategoryType = $o['CategoryType'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['SubCategoryListing'])) $this->SubCategoryListing = JsonConverters::fromArray('SubCategoryInfo', $o['SubCategoryListing']);
if (isset($o['PaymentCategoryType'])) $this->PaymentCategoryType = $o['PaymentCategoryType'];
if (isset($o['AllowedOnMobile'])) $this->AllowedOnMobile = $o['AllowedOnMobile'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CategoryNumber)) $o['CategoryNumber'] = $this->CategoryNumber;
if (isset($this->CategoryType)) $o['CategoryType'] = $this->CategoryType;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->SubCategoryListing)) $o['SubCategoryListing'] = JsonConverters::toArray('SubCategoryInfo', $this->SubCategoryListing);
if (isset($this->PaymentCategoryType)) $o['PaymentCategoryType'] = $this->PaymentCategoryType;
if (isset($this->AllowedOnMobile)) $o['AllowedOnMobile'] = $this->AllowedOnMobile;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class CategoryListingResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<CategoryInfo>|null */
public ?array $CategoryListing=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['CategoryListing'])) $this->CategoryListing = JsonConverters::fromArray('CategoryInfo', $o['CategoryListing']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CategoryListing)) $o['CategoryListing'] = JsonConverters::toArray('CategoryInfo', $this->CategoryListing);
return empty($o) ? new class(){} : $o;
}
}
/** @description CategoryListingRequires active-e Inventory Service. */
// @DataContract
class CategoryListingRequest 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 If true, Inactive Categories and Subcategories will be returned. Defaults to false. */
// @DataMember
// @ApiMember(DataType="boolean", Description="If true, Inactive Categories and Subcategories will be returned. Defaults to false.", Name="IncludeInactive", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeInactive=null,
/** @description Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored. */
// @DataMember
// @ApiMember(DataType="integer", Description="Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored.", Format="int64", Name="CategoryNumber", ParameterType="query")
/** @var int|null */
public ?int $CategoryNumber=null,
/** @description If true, Inventory Categories will be returned. Defaults to true. */
// @DataMember
// @ApiMember(DataType="boolean", Description="If true, Inventory Categories will be returned. Defaults to true.", Name="IncludeInventory", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeInventory=null,
/** @description If true, Non-Inventory Categories will be returned. Defaults to false. */
// @DataMember
// @ApiMember(DataType="boolean", Description="If true, Non-Inventory Categories will be returned. Defaults to false.", Name="IncludeNonInventory", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeNonInventory=null,
/** @description If true, Return Payment Categories will be returned. Defaults to false. */
// @DataMember
// @ApiMember(DataType="boolean", Description="If true, Return Payment Categories will be returned. Defaults to false.", Name="IncludeReturn", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeReturn=null,
/** @description If true, Payment Categories will be returned. Defaults to false. */
// @DataMember
// @ApiMember(DataType="boolean", Description="If true, Payment Categories will be returned. Defaults to false.", Name="IncludePayment", ParameterType="query")
/** @var bool|null */
public ?bool $IncludePayment=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['IncludeInactive'])) $this->IncludeInactive = $o['IncludeInactive'];
if (isset($o['CategoryNumber'])) $this->CategoryNumber = $o['CategoryNumber'];
if (isset($o['IncludeInventory'])) $this->IncludeInventory = $o['IncludeInventory'];
if (isset($o['IncludeNonInventory'])) $this->IncludeNonInventory = $o['IncludeNonInventory'];
if (isset($o['IncludeReturn'])) $this->IncludeReturn = $o['IncludeReturn'];
if (isset($o['IncludePayment'])) $this->IncludePayment = $o['IncludePayment'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->IncludeInactive)) $o['IncludeInactive'] = $this->IncludeInactive;
if (isset($this->CategoryNumber)) $o['CategoryNumber'] = $this->CategoryNumber;
if (isset($this->IncludeInventory)) $o['IncludeInventory'] = $this->IncludeInventory;
if (isset($this->IncludeNonInventory)) $o['IncludeNonInventory'] = $this->IncludeNonInventory;
if (isset($this->IncludeReturn)) $o['IncludeReturn'] = $this->IncludeReturn;
if (isset($this->IncludePayment)) $o['IncludePayment'] = $this->IncludePayment;
return empty($o) ? new class(){} : $o;
}
}
PHP CategoryListingRequest 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.
GET /api/CategoryListing HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CategoryListingResponse 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>
<CategoryListing>
<CategoryInfo>
<Active>false</Active>
<AllowedOnMobile>false</AllowedOnMobile>
<CategoryNumber>0</CategoryNumber>
<CategoryType>String</CategoryType>
<Description>String</Description>
<PaymentCategoryType>String</PaymentCategoryType>
<SubCategoryListing>
<SubCategoryInfo>
<Active>false</Active>
<Description>String</Description>
<Price>0</Price>
<SerialAttributes>
<SubCategoryAttributeInfo>
<AttributeName>String</AttributeName>
<Priority>0</Priority>
</SubCategoryAttributeInfo>
</SerialAttributes>
<SkuAttributes>
<SubCategoryAttributeInfo>
<AttributeName>String</AttributeName>
<Priority>0</Priority>
</SubCategoryAttributeInfo>
</SkuAttributes>
<SubNumber>0</SubNumber>
</SubCategoryInfo>
</SubCategoryListing>
</CategoryInfo>
</CategoryListing>
</CategoryListingResponse>