AIM Web Services

<back to all web services

InventoryAutoPriceRequest

InventoryAutoPrice
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryAutoPrice
<?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 AutoPriceRecord implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var int */
        public int $Id=0,

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

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

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

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Category'])) $this->Category = $o['Category'];
        if (isset($o['CategoryDescription'])) $this->CategoryDescription = $o['CategoryDescription'];
        if (isset($o['SubCategory'])) $this->SubCategory = $o['SubCategory'];
        if (isset($o['SubCategoryDescription'])) $this->SubCategoryDescription = $o['SubCategoryDescription'];
        if (isset($o['Vendor'])) $this->Vendor = $o['Vendor'];
        if (isset($o['VendorName'])) $this->VendorName = $o['VendorName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Category)) $o['Category'] = $this->Category;
        if (isset($this->CategoryDescription)) $o['CategoryDescription'] = $this->CategoryDescription;
        if (isset($this->SubCategory)) $o['SubCategory'] = $this->SubCategory;
        if (isset($this->SubCategoryDescription)) $o['SubCategoryDescription'] = $this->SubCategoryDescription;
        if (isset($this->Vendor)) $o['Vendor'] = $this->Vendor;
        if (isset($this->VendorName)) $o['VendorName'] = $this->VendorName;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class InventoryAutoPriceResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var array<AutoPriceRecord>|null */
        public ?array $AutoPriceRecords=null,

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

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

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

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

        // @DataMember
        /** @var float|null */
        public ?float $OurPrice=null
    ) {
        parent::__construct($Status);
    }

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

/** @description InventoryAutoPriceRequires active-e Inventory Service */
// @DataContract
class InventoryAutoPriceRequest 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 $Category=null,

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

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

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

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

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

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

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

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

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

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

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

        // @DataMember
        /** @var float */
        public float $VendorNormalCost=0.0
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Category'])) $this->Category = $o['Category'];
        if (isset($o['SubCategory'])) $this->SubCategory = $o['SubCategory'];
        if (isset($o['Vendor'])) $this->Vendor = $o['Vendor'];
        if (isset($o['AutoPriceId'])) $this->AutoPriceId = $o['AutoPriceId'];
        if (isset($o['MinimumPrice'])) $this->MinimumPrice = $o['MinimumPrice'];
        if (isset($o['PriceA'])) $this->PriceA = $o['PriceA'];
        if (isset($o['PriceB'])) $this->PriceB = $o['PriceB'];
        if (isset($o['PriceC'])) $this->PriceC = $o['PriceC'];
        if (isset($o['OurPrice'])) $this->OurPrice = $o['OurPrice'];
        if (isset($o['RetailPrice'])) $this->RetailPrice = $o['RetailPrice'];
        if (isset($o['Cost'])) $this->Cost = $o['Cost'];
        if (isset($o['WeightedCost'])) $this->WeightedCost = $o['WeightedCost'];
        if (isset($o['VendorNormalCost'])) $this->VendorNormalCost = $o['VendorNormalCost'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Category)) $o['Category'] = $this->Category;
        if (isset($this->SubCategory)) $o['SubCategory'] = $this->SubCategory;
        if (isset($this->Vendor)) $o['Vendor'] = $this->Vendor;
        if (isset($this->AutoPriceId)) $o['AutoPriceId'] = $this->AutoPriceId;
        if (isset($this->MinimumPrice)) $o['MinimumPrice'] = $this->MinimumPrice;
        if (isset($this->PriceA)) $o['PriceA'] = $this->PriceA;
        if (isset($this->PriceB)) $o['PriceB'] = $this->PriceB;
        if (isset($this->PriceC)) $o['PriceC'] = $this->PriceC;
        if (isset($this->OurPrice)) $o['OurPrice'] = $this->OurPrice;
        if (isset($this->RetailPrice)) $o['RetailPrice'] = $this->RetailPrice;
        if (isset($this->Cost)) $o['Cost'] = $this->Cost;
        if (isset($this->WeightedCost)) $o['WeightedCost'] = $this->WeightedCost;
        if (isset($this->VendorNormalCost)) $o['VendorNormalCost'] = $this->VendorNormalCost;
        return empty($o) ? new class(){} : $o;
    }
}

PHP InventoryAutoPriceRequest 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

HTTP + JSON

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

GET /api/InventoryAutoPrice HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AutoPriceRecords":[{"Id":0,"Description":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Vendor":0,"VendorName":"String"}],"MinimumPrice":0,"PriceA":0,"PriceB":0,"PriceC":0,"OurPrice":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}