Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

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

// @DataContract
export class V2BaseRequest
{

    public constructor(init?: Partial<V2BaseRequest>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<V2BaseResponse>) { (Object as any).assign(this, init); }
}

export enum AffiliateSettingsOption
{
    None = 'none',
    Custom = 'custom',
    Booklinker = 'booklinker',
}

export enum EnrollmentState
{
    None = 'none',
    Pending = 'pending',
    Approved = 'approved',
    Rejected = 'rejected',
}

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

    // @DataMember(Name="username")
    public username: string;

    // @DataMember(Name="userEmail")
    public userEmail: string;

    // @DataMember(Name="booklinkerToken")
    public booklinkerToken: string;

    // @DataMember(Name="customToken")
    public customToken: string;

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

    public constructor(init?: Partial<GetAppleServicesSettingsResponseData>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<GetAppleServicesSettingsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetAppleServicesSettingsRequest extends V2BaseRequest
{

    public constructor(init?: Partial<GetAppleServicesSettingsRequest>) { super(init); (Object as any).assign(this, init); }
}

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