| 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()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetLinksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
<allLinksLoaded>false</allLinksLoaded>
<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>
<results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.DTOs.Shortlinks">
<d2p1:LinkResult>
<d2p1:author>String</d2p1:author>
<d2p1:baseCode>String</d2p1:baseCode>
<d2p1:imageUrl>String</d2p1:imageUrl>
<d2p1:originalUrl>String</d2p1:originalUrl>
<d2p1:retailer>String</d2p1:retailer>
<d2p1:title>String</d2p1:title>
<d2p1:url>String</d2p1:url>
</d2p1:LinkResult>
</results>
</GetLinksResponse>