Booklinker.API

GetAccountRequest

The following routes are available for this service:
GET	/v1/account

<?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 V2BaseResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

/**
 * @property string|null $id
 * @property string|null $provider
 * @property string|null $providerImageId
 * @property string|null $url
 * @property array<string,string>|null $attributes
 */
interface IImageData
{
}

enum SignatureAppearance : string
{
    case None = 'none';
    case Text = 'text';
    case Upload = 'upload';
}

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

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

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

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

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
        if (isset($o['fullName'])) $this->fullName = $o['fullName'];
        if (isset($o['profileImage'])) $this->profileImage = JsonConverters::from('IImageData', $o['profileImage']);
        if (isset($o['signatureImage'])) $this->signatureImage = JsonConverters::from('IImageData', $o['signatureImage']);
        if (isset($o['signatureFont'])) $this->signatureFont = $o['signatureFont'];
        if (isset($o['signatureAppearance'])) $this->signatureAppearance = JsonConverters::from('SignatureAppearance', $o['signatureAppearance']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
        if (isset($this->fullName)) $o['fullName'] = $this->fullName;
        if (isset($this->profileImage)) $o['profileImage'] = JsonConverters::to('IImageData', $this->profileImage);
        if (isset($this->signatureImage)) $o['signatureImage'] = JsonConverters::to('IImageData', $this->signatureImage);
        if (isset($this->signatureFont)) $o['signatureFont'] = $this->signatureFont;
        if (isset($this->signatureAppearance)) $o['signatureAppearance'] = JsonConverters::to('SignatureAppearance', $this->signatureAppearance);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAccountResponse extends V2BaseResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        // @DataMember(Name="data")
        /** @var AccountData|null */
        public ?AccountData $data=null
    ) {
        parent::__construct($responseStatus);
    }

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

// @DataContract
class GetAccountRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetAccountRequest 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/account HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsonl

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

{"userAccount":{"email":"String","settings":{"id":"String","profileImageId":"String","signatureImageId":"String","signatureText":"String","signatureFont":"String","signatureAppearance":"none"}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}