Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
GetAppleServicesSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformGetAppleServicesSettingsResponseDataNo
V2BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GetAppleServicesSettingsResponseData Parameters:
NameParameterData TypeRequiredDescription
SelectedOptionformAffiliateSettingsOptionNo
UsernameformstringNo
UserEmailformstringNo
BooklinkerTokenformstringNo
CustomTokenformstringNo
EnrollmentStateformEnrollmentStateNo
AffiliateSettingsOption Enum:
NameValue
Nonenone
Customcustom
Booklinkerbooklinker
EnrollmentState Enum:
NameValue
Nonenone
Pendingpending
Approvedapproved
Rejectedrejected

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}