Booklinker.API

<back to all web services

PostLinkIssueReportRequest

The following routes are available for this service:
POST/v1/report-link-issue
<?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 PostLinkIssueReportResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="success")
        /** @var bool|null */
        public ?bool $success=null,

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

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

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

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

        // @DataMember(Name="issues")
        // @ApiMember(IsRequired=true, Name="issues")
        /** @var string[] */
        public array $issues=[],

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

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

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

PHP PostLinkIssueReportRequest DTOs

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

HTTP + CSV

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

POST /v1/report-link-issue HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"aliasDomain":"String","aliasCode":"String","issues":["String"],"email":"String","notes":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}