Booklinker.API

GetLinksRequest

The following routes are available for this service:
GET	/v1/links/list

import 'package:servicestack/servicestack.dart';

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

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

    PaginatedBaseRequest({this.skip,this.take});
    PaginatedBaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        skip = json['skip'];
        take = json['take'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'skip': skip,
        'take': take
    };

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

// @DataContract
class LinkResult implements IConvertible
{
    // @DataMember(Name="baseCode")
    String? baseCode;

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

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

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

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

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

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

    LinkResult({this.baseCode,this.url,this.originalUrl,this.imageUrl,this.retailer,this.title,this.author});
    LinkResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        baseCode = json['baseCode'];
        url = json['url'];
        originalUrl = json['originalUrl'];
        imageUrl = json['imageUrl'];
        retailer = json['retailer'];
        title = json['title'];
        author = json['author'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'baseCode': baseCode,
        'url': url,
        'originalUrl': originalUrl,
        'imageUrl': imageUrl,
        'retailer': retailer,
        'title': title,
        'author': author
    };

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

// @DataContract
class GetLinksResponse implements IConvertible
{
    // @DataMember(Name="allLinksLoaded")
    bool? allLinksLoaded;

    // @DataMember(Name="results")
    List<LinkResult>? results;

    // @DataMember(Name="responseStatus")
    ResponseStatus? responseStatus;

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

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

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

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

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

    GetLinksRequest({this.ids});
    GetLinksRequest.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() => "GetLinksRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'PaginatedBaseRequest': TypeInfo(TypeOf.Class, create:() => PaginatedBaseRequest()),
    'LinkResult': TypeInfo(TypeOf.Class, create:() => LinkResult()),
    'GetLinksResponse': TypeInfo(TypeOf.Class, create:() => GetLinksResponse()),
    'List<LinkResult>': TypeInfo(TypeOf.Class, create:() => <LinkResult>[]),
    'GetLinksRequest': TypeInfo(TypeOf.Class, create:() => GetLinksRequest()),
});

Dart GetLinksRequest DTOs

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

HTTP + OTHER

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

GET /v1/links/list HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsonl

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

{"allLinksLoaded":false,"results":[{"baseCode":"String","url":"String","originalUrl":"String","imageUrl":"String","retailer":"String","title":"String","author":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}