BokaMera.API.Host

<back to all web services

GetVossProducts

<?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};


enum TypeEnum : int
{
    case Main = 1;
    case Addon = 2;
    case License = 3;
    case Usage = 4;
}

enum StatusEnum : int
{
    case Published = 1;
    case Disabled = 2;
}

// @DataContract(Name="ProductResultProductFamilyDto")
class ProductResultProductFamilyDto implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="id", IsRequired=true)
        /** @var string */
        public string $id='',

        // @DataMember(Name="externalId")
        /** @var string */
        public string $externalId=''
    ) {
    }

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

// @DataContract(Name="ProductResult")
class ProductResult implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="type", IsRequired=true)
        /** @var TypeEnum|null */
        public ?TypeEnum $type=null,

        // @DataMember(Name="status", IsRequired=true)
        /** @var StatusEnum|null */
        public ?StatusEnum $status=null,

        // @DataMember(Name="id", IsRequired=true)
        /** @var string */
        public string $id='',

        // @DataMember(Name="name", IsRequired=true)
        /** @var string */
        public string $name='',

        // @DataMember(Name="externalId")
        /** @var string */
        public string $externalId='',

        // @DataMember(Name="articleNumber", IsRequired=true)
        /** @var string */
        public string $articleNumber='',

        // @DataMember(Name="productFamily", IsRequired=true)
        /** @var ProductResultProductFamilyDto|null */
        public ?ProductResultProductFamilyDto $productFamily=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['type'])) $this->type = JsonConverters::from('TypeEnum', $o['type']);
        if (isset($o['status'])) $this->status = JsonConverters::from('StatusEnum', $o['status']);
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['externalId'])) $this->externalId = $o['externalId'];
        if (isset($o['articleNumber'])) $this->articleNumber = $o['articleNumber'];
        if (isset($o['productFamily'])) $this->productFamily = JsonConverters::from('ProductResultProductFamilyDto', $o['productFamily']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->type)) $o['type'] = JsonConverters::to('TypeEnum', $this->type);
        if (isset($this->status)) $o['status'] = JsonConverters::to('StatusEnum', $this->status);
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->externalId)) $o['externalId'] = $this->externalId;
        if (isset($this->articleNumber)) $o['articleNumber'] = $this->articleNumber;
        if (isset($this->productFamily)) $o['productFamily'] = JsonConverters::to('ProductResultProductFamilyDto', $this->productFamily);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract(Name="SearchProductsResult")
class SearchProductsResult implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="items", EmitDefaultValue=false)
        /** @var array<ProductResult>|null */
        public ?array $items=null,

        // @DataMember(Name="totalCount", EmitDefaultValue=false)
        /** @var int */
        public int $totalCount=0,

        // @DataMember(Name="pageIndex", EmitDefaultValue=false)
        /** @var int */
        public int $pageIndex=0,

        // @DataMember(Name="pageSize", EmitDefaultValue=false)
        /** @var int */
        public int $pageSize=0,

        // @DataMember(Name="totalPages", EmitDefaultValue=false)
        /** @var int */
        public int $totalPages=0
    ) {
    }

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class GetVossProducts implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null
    ) {
    }

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

PHP GetVossProducts DTOs

GET /voss/products HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<SearchProductsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VossIntegration.ApiTools.Model">
  <items>
    <ProductResult i:nil="true" />
  </items>
</SearchProductsResult>