Booklinker.API

GetLinksRequest

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

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 PaginatedBaseRequest:
    skip: int = 0
    take: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkResult:
    base_code: Optional[str] = None
    url: Optional[str] = None
    original_url: Optional[str] = None
    image_url: Optional[str] = None
    retailer: Optional[str] = None
    title: Optional[str] = None
    author: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLinksResponse:
    all_links_loaded: bool = False
    results: Optional[List[LinkResult]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLinksRequest(PaginatedBaseRequest):
    ids: Optional[List[str]] = None

Python GetLinksRequest 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/links/list HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

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

{
	allLinksLoaded: False,
	results: 
	[
		{
			baseCode: String,
			url: String,
			originalUrl: String,
			imageUrl: String,
			retailer: String,
			title: String,
			author: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}