Booklinker.API

<back to all web services

GetAccountRequest

Requires Authentication
The following routes are available for this service:
GET/v1/account
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V2BaseResponse:
    response_status: Optional[ResponseStatus] = None


class IImageData:
    id: Optional[str] = None
    provider: Optional[str] = None
    provider_image_id: Optional[str] = None
    url: Optional[str] = None
    attributes: Optional[Dict[str, str]] = None


class SignatureAppearance(str, Enum):
    NONE = 'none'
    TEXT = 'text'
    UPLOAD = 'upload'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountData:
    id: Optional[str] = None
    user_id: Optional[str] = None
    email_address: Optional[str] = None
    full_name: Optional[str] = None
    profile_image: Optional[IImageData] = None
    signature_image: Optional[IImageData] = None
    signature_font: Optional[str] = None
    signature_appearance: Optional[SignatureAppearance] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAccountResponse(V2BaseResponse):
    data: Optional[AccountData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAccountRequest:
    pass

Python GetAccountRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}