Booklinker.API

<back to all web services

PutAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
PUT/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); }
}

// @DataContract
export class PutAppleServicesSettingsResponse extends V2BaseResponse
{

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

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

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

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

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

TypeScript PutAppleServicesSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v2/settings/apple-services HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"selectedOption":"none","customToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}