AIM Web Services

<back to all web services

InventoryLookupRequest

InventoryLookup
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryLookup
<?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 InventoryLookupObj implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $ResultType=null,

        // @DataMember
        /** @var string|null */
        public ?string $Sku=null,

        // @DataMember
        /** @var string|null */
        public ?string $Serial=null,

        // @DataMember
        /** @var int */
        public int $Category=0,

        // @DataMember
        /** @var int */
        public int $SubCategory=0,

        // @DataMember
        /** @var string|null */
        public ?string $Description=null,

        // @DataMember
        /** @var float */
        public float $ComputerQty=0.0,

        // @DataMember
        /** @var float */
        public float $AvailableQty=0.0,

        // @DataMember
        /** @var int */
        public int $SadPk=0,

        // @DataMember
        /** @var int */
        public int $SkuPk=0,

        // @DataMember
        /** @var int|null */
        public ?int $SasPk=null,

        // @DataMember
        /** @var string|null */
        public ?string $InventoryType=null,

        // @DataMember
        /** @var float|null */
        public ?float $NicsPrice=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $ADBookItem=null,

        // @DataMember
        /** @var string|null */
        public ?string $LocationCode=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResultType'])) $this->ResultType = $o['ResultType'];
        if (isset($o['Sku'])) $this->Sku = $o['Sku'];
        if (isset($o['Serial'])) $this->Serial = $o['Serial'];
        if (isset($o['Category'])) $this->Category = $o['Category'];
        if (isset($o['SubCategory'])) $this->SubCategory = $o['SubCategory'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['ComputerQty'])) $this->ComputerQty = $o['ComputerQty'];
        if (isset($o['AvailableQty'])) $this->AvailableQty = $o['AvailableQty'];
        if (isset($o['SadPk'])) $this->SadPk = $o['SadPk'];
        if (isset($o['SkuPk'])) $this->SkuPk = $o['SkuPk'];
        if (isset($o['SasPk'])) $this->SasPk = $o['SasPk'];
        if (isset($o['InventoryType'])) $this->InventoryType = $o['InventoryType'];
        if (isset($o['NicsPrice'])) $this->NicsPrice = $o['NicsPrice'];
        if (isset($o['ADBookItem'])) $this->ADBookItem = $o['ADBookItem'];
        if (isset($o['LocationCode'])) $this->LocationCode = $o['LocationCode'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResultType)) $o['ResultType'] = $this->ResultType;
        if (isset($this->Sku)) $o['Sku'] = $this->Sku;
        if (isset($this->Serial)) $o['Serial'] = $this->Serial;
        if (isset($this->Category)) $o['Category'] = $this->Category;
        if (isset($this->SubCategory)) $o['SubCategory'] = $this->SubCategory;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->ComputerQty)) $o['ComputerQty'] = $this->ComputerQty;
        if (isset($this->AvailableQty)) $o['AvailableQty'] = $this->AvailableQty;
        if (isset($this->SadPk)) $o['SadPk'] = $this->SadPk;
        if (isset($this->SkuPk)) $o['SkuPk'] = $this->SkuPk;
        if (isset($this->SasPk)) $o['SasPk'] = $this->SasPk;
        if (isset($this->InventoryType)) $o['InventoryType'] = $this->InventoryType;
        if (isset($this->NicsPrice)) $o['NicsPrice'] = $this->NicsPrice;
        if (isset($this->ADBookItem)) $o['ADBookItem'] = $this->ADBookItem;
        if (isset($this->LocationCode)) $o['LocationCode'] = $this->LocationCode;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class InventoryLookupResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var array<InventoryLookupObj>|null */
        public ?array $Results=null
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('InventoryLookupObj', $o['Results']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('InventoryLookupObj', $this->Results);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description InventoryLookupRequires active-e Inventory Service */
// @DataContract
class InventoryLookupRequest 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 string|null */
        public ?string $Item=null,

        // @DataMember
        /** @var string|null */
        public ?string $LocationCode=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Item'])) $this->Item = $o['Item'];
        if (isset($o['LocationCode'])) $this->LocationCode = $o['LocationCode'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Item)) $o['Item'] = $this->Item;
        if (isset($this->LocationCode)) $o['LocationCode'] = $this->LocationCode;
        return empty($o) ? new class(){} : $o;
    }
}

PHP InventoryLookupRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/InventoryLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Results":[{"ResultType":"String","Sku":"String","Serial":"String","Category":0,"SubCategory":0,"Description":"String","ComputerQty":0,"AvailableQty":0,"SadPk":0,"SkuPk":0,"SasPk":0,"InventoryType":"String","NicsPrice":0,"ADBookItem":false,"LocationCode":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}