Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
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 V2BaseRequest:
    pass


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


class AffiliateSettingsOption(str, Enum):
    NONE = 'none'
    CUSTOM = 'custom'
    BOOKLINKER = 'booklinker'


class EnrollmentState(str, Enum):
    NONE = 'none'
    PENDING = 'pending'
    APPROVED = 'approved'
    REJECTED = 'rejected'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAppleServicesSettingsResponseData:
    selected_option: Optional[AffiliateSettingsOption] = None
    username: Optional[str] = None
    user_email: Optional[str] = None
    booklinker_token: Optional[str] = None
    custom_token: Optional[str] = None
    enrollment_state: Optional[EnrollmentState] = None


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


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

Python GetAppleServicesSettingsRequest 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 /v2/settings/apple-services HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		selectedOption: none,
		username: String,
		userEmail: String,
		booklinkerToken: String,
		customToken: String,
		enrollmentState: none
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}