Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetAppleServicesSettingsRequest : V2BaseRequest()
{
}

@DataContract
open class V2BaseRequest
{
}

@DataContract
open class GetAppleServicesSettingsResponse : V2BaseResponse()
{
    @DataMember(Name="data")
    @SerializedName("data")
    open var Data:GetAppleServicesSettingsResponseData? = null
}

@DataContract
open class V2BaseResponse
{
    @DataMember(Name="responseStatus")
    @SerializedName("responseStatus")
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class GetAppleServicesSettingsResponseData
{
    @DataMember(Name="selectedOption")
    @SerializedName("selectedOption")
    open var selectedOption:AffiliateSettingsOption? = null

    @DataMember(Name="username")
    @SerializedName("username")
    open var username:String? = null

    @DataMember(Name="userEmail")
    @SerializedName("userEmail")
    open var userEmail:String? = null

    @DataMember(Name="booklinkerToken")
    @SerializedName("booklinkerToken")
    open var booklinkerToken:String? = null

    @DataMember(Name="customToken")
    @SerializedName("customToken")
    open var customToken:String? = null

    @DataMember(Name="enrollmentState")
    @SerializedName("enrollmentState")
    open var enrollmentState:EnrollmentState? = null
}

enum class AffiliateSettingsOption
{
    None,
    Custom,
    Booklinker,
}

enum class EnrollmentState
{
    None,
    Pending,
    Approved,
    Rejected,
}

Kotlin 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>