Booklinker.API

PostUnclaimedLinkCreationRequest

The following routes are available for this service:
POST	/v1/links/unclaimed

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 PostLinkCreationRequestBase:
    # @ApiMember(IsRequired=true)
    url: Optional[str] = None

    domain: Optional[str] = None
    parameter_key_values: Optional[Dict[str, str]] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostLinkCreationResponse:
    success: bool = False
    link_result: Optional[str] = None
    destinations: Optional[List[ProductMetadata]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AffiliateTokens:
    guid: Optional[str] = None
    program_guid: Optional[str] = None
    tokens: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostUnclaimedLinkCreationRequest(PostLinkCreationRequestBase):
    affiliate_programs: Optional[List[AffiliateTokens]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductMetadata:
    title: Optional[str] = None
    author: Optional[str] = None
    url: Optional[str] = None
    description: Optional[str] = None
    retailer: Optional[str] = None
    product_images: Optional[Dict[str, str]] = None

Python PostUnclaimedLinkCreationRequest 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/links/unclaimed HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"affiliatePrograms":[{"affiliateTokens":{"String":"String"}}],"url":"String","domain":"String","parameterKeyValues":{"String":"String"}}

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

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