Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V2.Requests.AppleServices
Imports Booklinker.API.ServiceModel.V2.Requests
Imports Booklinker.API.ServiceModel.V2.Responses.AppleServices
Imports Booklinker.API.ServiceModel.V2.Responses
Imports Booklinker.API.ServiceModel.DTOs.AppleServices

Namespace Global

    Namespace Booklinker.API.ServiceModel.DTOs.AppleServices

        Public Enum AffiliateSettingsOption
            <EnumMember(Value:="none")>
            None
            <EnumMember(Value:="custom")>
            Custom
            <EnumMember(Value:="booklinker")>
            Booklinker
        End Enum

        Public Enum EnrollmentState
            <EnumMember(Value:="none")>
            None
            <EnumMember(Value:="pending")>
            Pending
            <EnumMember(Value:="approved")>
            Approved
            <EnumMember(Value:="rejected")>
            Rejected
        End Enum
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Requests

        <DataContract>
        Public Partial Class V2BaseRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Requests.AppleServices

        <DataContract>
        Public Partial Class GetAppleServicesSettingsRequest
            Inherits V2BaseRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class V2BaseResponse
            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses.AppleServices

        <DataContract>
        Public Partial Class GetAppleServicesSettingsResponse
            Inherits V2BaseResponse
            <DataMember(Name:="data")>
            Public Overridable Property Data As GetAppleServicesSettingsResponseData
        End Class

        <DataContract>
        Public Partial Class GetAppleServicesSettingsResponseData
            <DataMember(Name:="selectedOption")>
            Public Overridable Property SelectedOption As AffiliateSettingsOption

            <DataMember(Name:="username")>
            Public Overridable Property Username As String

            <DataMember(Name:="userEmail")>
            Public Overridable Property UserEmail As String

            <DataMember(Name:="booklinkerToken")>
            Public Overridable Property BooklinkerToken As String

            <DataMember(Name:="customToken")>
            Public Overridable Property CustomToken As String

            <DataMember(Name:="enrollmentState")>
            Public Overridable Property EnrollmentState As EnrollmentState
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}