Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

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

namespace Booklinker.API.ServiceModel.DTOs.AppleServices
{
    public enum AffiliateSettingsOption
    {
        [EnumMember(Value="none")]
        None,
        [EnumMember(Value="custom")]
        Custom,
        [EnumMember(Value="booklinker")]
        Booklinker,
    }

    public enum EnrollmentState
    {
        [EnumMember(Value="none")]
        None,
        [EnumMember(Value="pending")]
        Pending,
        [EnumMember(Value="approved")]
        Approved,
        [EnumMember(Value="rejected")]
        Rejected,
    }

}

namespace Booklinker.API.ServiceModel.V2.Requests
{
    [DataContract]
    public partial class V2BaseRequest
    {
    }

}

namespace Booklinker.API.ServiceModel.V2.Requests.AppleServices
{
    [DataContract]
    public partial class GetAppleServicesSettingsRequest
        : V2BaseRequest
    {
    }

}

namespace Booklinker.API.ServiceModel.V2.Responses
{
    [DataContract]
    public partial class V2BaseResponse
    {
        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V2.Responses.AppleServices
{
    [DataContract]
    public partial class GetAppleServicesSettingsResponse
        : V2BaseResponse
    {
        [DataMember(Name="data")]
        public virtual GetAppleServicesSettingsResponseData Data { get; set; }
    }

    [DataContract]
    public partial class GetAppleServicesSettingsResponseData
    {
        [DataMember(Name="selectedOption")]
        public virtual AffiliateSettingsOption SelectedOption { get; set; }

        [DataMember(Name="username")]
        public virtual string Username { get; set; }

        [DataMember(Name="userEmail")]
        public virtual string UserEmail { get; set; }

        [DataMember(Name="booklinkerToken")]
        public virtual string BooklinkerToken { get; set; }

        [DataMember(Name="customToken")]
        public virtual string CustomToken { get; set; }

        [DataMember(Name="enrollmentState")]
        public virtual EnrollmentState EnrollmentState { get; set; }
    }

}

C# 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
		}
	}
}