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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAppleServicesSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses.AppleServices">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
  <data>
    <booklinkerToken>String</booklinkerToken>
    <customToken>String</customToken>
    <enrollmentState>None</enrollmentState>
    <selectedOption>None</selectedOption>
    <userEmail>String</userEmail>
    <username>String</username>
  </data>
</GetAppleServicesSettingsResponse>