Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
import 'package:servicestack/servicestack.dart';

// @DataContract
class V2BaseRequest implements IConvertible
{
    V2BaseRequest();
    V2BaseRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "V2BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class V2BaseResponse implements IConvertible
{
    // @DataMember(Name="responseStatus")
    ResponseStatus? responseStatus;

    V2BaseResponse({this.responseStatus});
    V2BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "V2BaseResponse";
    TypeContext? context = _ctx;
}

enum AffiliateSettingsOption
{
    None,
    Custom,
    Booklinker,
}

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

// @DataContract
class GetAppleServicesSettingsResponseData implements IConvertible
{
    // @DataMember(Name="selectedOption")
    AffiliateSettingsOption? selectedOption;

    // @DataMember(Name="username")
    String? username;

    // @DataMember(Name="userEmail")
    String? userEmail;

    // @DataMember(Name="booklinkerToken")
    String? booklinkerToken;

    // @DataMember(Name="customToken")
    String? customToken;

    // @DataMember(Name="enrollmentState")
    EnrollmentState? enrollmentState;

    GetAppleServicesSettingsResponseData({this.selectedOption,this.username,this.userEmail,this.booklinkerToken,this.customToken,this.enrollmentState});
    GetAppleServicesSettingsResponseData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        selectedOption = JsonConverters.fromJson(json['selectedOption'],'AffiliateSettingsOption',context!);
        username = json['username'];
        userEmail = json['userEmail'];
        booklinkerToken = json['booklinkerToken'];
        customToken = json['customToken'];
        enrollmentState = JsonConverters.fromJson(json['enrollmentState'],'EnrollmentState',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'selectedOption': JsonConverters.toJson(selectedOption,'AffiliateSettingsOption',context!),
        'username': username,
        'userEmail': userEmail,
        'booklinkerToken': booklinkerToken,
        'customToken': customToken,
        'enrollmentState': JsonConverters.toJson(enrollmentState,'EnrollmentState',context!)
    };

    getTypeName() => "GetAppleServicesSettingsResponseData";
    TypeContext? context = _ctx;
}

// @DataContract
class GetAppleServicesSettingsResponse extends V2BaseResponse implements IConvertible
{
    // @DataMember(Name="data")
    GetAppleServicesSettingsResponseData? data;

    GetAppleServicesSettingsResponse({this.data});
    GetAppleServicesSettingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        data = JsonConverters.fromJson(json['data'],'GetAppleServicesSettingsResponseData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'data': JsonConverters.toJson(data,'GetAppleServicesSettingsResponseData',context!)
    });

    getTypeName() => "GetAppleServicesSettingsResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class GetAppleServicesSettingsRequest extends V2BaseRequest implements IConvertible
{
    GetAppleServicesSettingsRequest();
    GetAppleServicesSettingsRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetAppleServicesSettingsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'V2BaseRequest': TypeInfo(TypeOf.Class, create:() => V2BaseRequest()),
    'V2BaseResponse': TypeInfo(TypeOf.Class, create:() => V2BaseResponse()),
    'AffiliateSettingsOption': TypeInfo(TypeOf.Enum, enumValues:AffiliateSettingsOption.values),
    'EnrollmentState': TypeInfo(TypeOf.Enum, enumValues:EnrollmentState.values),
    'GetAppleServicesSettingsResponseData': TypeInfo(TypeOf.Class, create:() => GetAppleServicesSettingsResponseData()),
    'GetAppleServicesSettingsResponse': TypeInfo(TypeOf.Class, create:() => GetAppleServicesSettingsResponse()),
    'GetAppleServicesSettingsRequest': TypeInfo(TypeOf.Class, create:() => GetAppleServicesSettingsRequest()),
});

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