Booklinker.API

<back to all web services

GetProductMetadataRequest

The following routes are available for this service:
GET/v1/product/metadata
<?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 ProductMetadata extends ProductMetadata implements JsonSerializable
{
    /**
     * @param string|null $title
     * @param string|null $author
     * @param string|null $url
     * @param string|null $description
     * @param string|null $retailer
     * @param array<string,string>|null $productImages
     */
    public function __construct(
        ?string $title=null,
        ?string $author=null,
        ?string $url=null,
        ?string $description=null,
        ?string $retailer=null,
        ?array $productImages=null
    ) {
        parent::__construct($title,$author,$url,$description,$retailer,$productImages);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetProductMetadataResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="productMetadata")
        /** @var ProductMetadata|null */
        public ?ProductMetadata $productMetadata=null,

        // @DataMember(Name="isSupported")
        /** @var bool|null */
        public ?bool $isSupported=null,

        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['productMetadata'])) $this->productMetadata = JsonConverters::from('ProductMetadata', $o['productMetadata']);
        if (isset($o['isSupported'])) $this->isSupported = $o['isSupported'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->productMetadata)) $o['productMetadata'] = JsonConverters::to('ProductMetadata', $this->productMetadata);
        if (isset($this->isSupported)) $o['isSupported'] = $this->isSupported;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetProductMetadataRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="url")
        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $url=''
    ) {
    }

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

// @DataContract
class ProductMetadata implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="title")
        /** @var string|null */
        public ?string $title=null,

        // @DataMember(Name="author")
        /** @var string|null */
        public ?string $author=null,

        // @DataMember(Name="url")
        /** @var string|null */
        public ?string $url=null,

        // @DataMember(Name="description")
        /** @var string|null */
        public ?string $description=null,

        // @DataMember(Name="retailer")
        /** @var string|null */
        public ?string $retailer=null,

        // @DataMember(Name="productImages")
        /** @var array<string,string>|null */
        public ?array $productImages=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['author'])) $this->author = $o['author'];
        if (isset($o['url'])) $this->url = JsonConverters::from('string', $o['url']);
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['retailer'])) $this->retailer = $o['retailer'];
        if (isset($o['productImages'])) $this->productImages = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Uri']), $o['productImages']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->author)) $o['author'] = $this->author;
        if (isset($this->url)) $o['url'] = JsonConverters::to('string', $this->url);
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->retailer)) $o['retailer'] = $this->retailer;
        if (isset($this->productImages)) $o['productImages'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Uri']), $this->productImages);
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetProductMetadataRequest 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 /v1/product/metadata HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsonl

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

{"productMetadata":{"title":"String","author":"String","description":"String","retailer":"String"},"isSupported":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}