Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
import Foundation
import ServiceStack

// @DataContract
public class GetAppleServicesSettingsRequest : V2BaseRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class V2BaseRequest : Codable
{
    required public init(){}
}

// @DataContract
public class GetAppleServicesSettingsResponse : V2BaseResponse
{
    // @DataMember(Name="data")
    public var data:GetAppleServicesSettingsResponseData

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        data = try container.decodeIfPresent(GetAppleServicesSettingsResponseData.self, forKey: .data)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if data != nil { try container.encode(data, forKey: .data) }
    }
}

// @DataContract
public class V2BaseResponse : Codable
{
    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class GetAppleServicesSettingsResponseData : Codable
{
    // @DataMember(Name="selectedOption")
    public var selectedOption:AffiliateSettingsOption

    // @DataMember(Name="username")
    public var username:String

    // @DataMember(Name="userEmail")
    public var userEmail:String

    // @DataMember(Name="booklinkerToken")
    public var booklinkerToken:String

    // @DataMember(Name="customToken")
    public var customToken:String

    // @DataMember(Name="enrollmentState")
    public var enrollmentState:EnrollmentState

    required public init(){}
}

public enum AffiliateSettingsOption : String, Codable
{
    case None
    case Custom
    case Booklinker
}

public enum EnrollmentState : String, Codable
{
    case None
    case Pending
    case Approved
    case Rejected
}


Swift 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
		}
	}
}