Booklinker.API

<back to all web services

GetCollectionsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/collections/list
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 V2PaginatedBaseRequest extends V2BaseRequest implements IConvertible
{
    // @DataMember(Name="offset")
    int? offset;

    // @DataMember(Name="limit")
    int? limit;

    V2PaginatedBaseRequest({this.offset,this.limit});
    V2PaginatedBaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        offset = json['offset'];
        limit = json['limit'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'offset': offset,
        'limit': limit
    });

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

// @DataContract
class V2ListRequest extends V2PaginatedBaseRequest implements IConvertible
{
    // @DataMember(Name="ids")
    List<String>? ids;

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

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

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

    getTypeName() => "V2ListRequest";
    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;
}

// @DataContract
class V2PageObject implements IConvertible
{
    // @DataMember(Name="offset")
    int? offset;

    // @DataMember(Name="limit")
    int? limit;

    // @DataMember(Name="totalRecords")
    int? totalRecords;

    V2PageObject({this.offset,this.limit,this.totalRecords});
    V2PageObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        offset = json['offset'];
        limit = json['limit'];
        totalRecords = json['totalRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'offset': offset,
        'limit': limit,
        'totalRecords': totalRecords
    };

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

// @DataContract
class V2PaginatedBaseResponse extends V2BaseResponse implements IConvertible
{
    // @DataMember(Name="page")
    V2PageObject? page;

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

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

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

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

// @DataContract
class GetCollectionsResponse extends V2PaginatedBaseResponse implements IGetCollectionsResponse, IConvertible
{
    GetCollectionsResponse();
    GetCollectionsResponse.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() => "GetCollectionsResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class GetCollectionsRequest extends V2ListRequest implements IConvertible
{
    GetCollectionsRequest();
    GetCollectionsRequest.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() => "GetCollectionsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'V2BaseRequest': TypeInfo(TypeOf.Class, create:() => V2BaseRequest()),
    'V2PaginatedBaseRequest': TypeInfo(TypeOf.Class, create:() => V2PaginatedBaseRequest()),
    'V2ListRequest': TypeInfo(TypeOf.Class, create:() => V2ListRequest()),
    'V2BaseResponse': TypeInfo(TypeOf.Class, create:() => V2BaseResponse()),
    'V2PageObject': TypeInfo(TypeOf.Class, create:() => V2PageObject()),
    'V2PaginatedBaseResponse': TypeInfo(TypeOf.Class, create:() => V2PaginatedBaseResponse()),
    'GetCollectionsResponse': TypeInfo(TypeOf.Class, create:() => GetCollectionsResponse()),
    'GetCollectionsRequest': TypeInfo(TypeOf.Class, create:() => GetCollectionsRequest()),
});

Dart GetCollectionsRequest 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/collections/list HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCollectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <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>
  <page>
    <limit>0</limit>
    <offset>0</offset>
    <totalRecords>0</totalRecords>
  </page>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.DTOs.V2" i:nil="true" />
</GetCollectionsResponse>