Booklinker.API

GetCollectionRequest

The following routes are available for this service:
GET	/v2/collections
GET	/v2/collections/{Id}

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;
}

// @DataContract
class UserCollection implements IUserCollection, IConvertible
{
    // @DataMember(Name="type")
    String? type;

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

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

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

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

    // @DataMember(Name="linkIds")
    List<String>? linkIds;

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

    UserCollection({this.type,this.id,this.baseCode,this.url,this.title,this.linkIds,this.collectionSettingsId});
    UserCollection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        type = json['type'];
        id = json['id'];
        baseCode = json['baseCode'];
        url = json['url'];
        title = json['title'];
        linkIds = JsonConverters.fromJson(json['linkIds'],'List<String>',context!);
        collectionSettingsId = json['collectionSettingsId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'type': type,
        'id': id,
        'baseCode': baseCode,
        'url': url,
        'title': title,
        'linkIds': JsonConverters.toJson(linkIds,'List<String>',context!),
        'collectionSettingsId': collectionSettingsId
    };

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

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

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

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

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

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

// @DataContract
class GetCollectionRequest extends V2BaseRequest implements IConvertible
{
    // @DataMember(Name="id")
    String? id;

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

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

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

    getTypeName() => "GetCollectionRequest";
    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()),
    'UserCollection': TypeInfo(TypeOf.Class, create:() => UserCollection()),
    'GetCollectionResponse': TypeInfo(TypeOf.Class, create:() => GetCollectionResponse()),
    'GetCollectionRequest': TypeInfo(TypeOf.Class, create:() => GetCollectionRequest()),
});

Dart GetCollectionRequest DTOs

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

HTTP + JSV

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

GET /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		type: collection,
		id: String,
		baseCode: String,
		url: String,
		title: String,
		collectionSettingsId: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}