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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}