Booklinker.API

<back to all web services

GetLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v1/links/list
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @DataContract
    public static class GetLinksRequest extends PaginatedBaseRequest
    {
        @DataMember(Name="ids")
        @SerializedName("ids")
        public ArrayList<String> ids = null;
        
        public ArrayList<String> getIds() { return ids; }
        public GetLinksRequest setIds(ArrayList<String> value) { this.ids = value; return this; }
    }

    @DataContract
    public static class PaginatedBaseRequest
    {
        @DataMember(Name="skip")
        @SerializedName("skip")
        public Integer skip = null;

        @DataMember(Name="take")
        @SerializedName("take")
        public Integer take = null;
        
        public Integer getSkip() { return skip; }
        public PaginatedBaseRequest setSkip(Integer value) { this.skip = value; return this; }
        public Integer getTake() { return take; }
        public PaginatedBaseRequest setTake(Integer value) { this.take = value; return this; }
    }

    @DataContract
    public static class GetLinksResponse
    {
        @DataMember(Name="allLinksLoaded")
        @SerializedName("allLinksLoaded")
        public Boolean allLinksLoaded = null;

        @DataMember(Name="results")
        @SerializedName("results")
        public ArrayList<LinkResult> results = null;

        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public Boolean isAllLinksLoaded() { return allLinksLoaded; }
        public GetLinksResponse setAllLinksLoaded(Boolean value) { this.allLinksLoaded = value; return this; }
        public ArrayList<LinkResult> getResults() { return results; }
        public GetLinksResponse setResults(ArrayList<LinkResult> value) { this.results = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetLinksResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class LinkResult
    {
        @DataMember(Name="baseCode")
        @SerializedName("baseCode")
        public String baseCode = null;

        @DataMember(Name="url")
        @SerializedName("url")
        public String url = null;

        @DataMember(Name="originalUrl")
        @SerializedName("originalUrl")
        public String originalUrl = null;

        @DataMember(Name="imageUrl")
        @SerializedName("imageUrl")
        public String imageUrl = null;

        @DataMember(Name="retailer")
        @SerializedName("retailer")
        public String retailer = null;

        @DataMember(Name="title")
        @SerializedName("title")
        public String title = null;

        @DataMember(Name="author")
        @SerializedName("author")
        public String author = null;
        
        public String getBaseCode() { return baseCode; }
        public LinkResult setBaseCode(String value) { this.baseCode = value; return this; }
        public String getUrl() { return url; }
        public LinkResult setUrl(String value) { this.url = value; return this; }
        public String getOriginalUrl() { return originalUrl; }
        public LinkResult setOriginalUrl(String value) { this.originalUrl = value; return this; }
        public String getImageUrl() { return imageUrl; }
        public LinkResult setImageUrl(String value) { this.imageUrl = value; return this; }
        public String getRetailer() { return retailer; }
        public LinkResult setRetailer(String value) { this.retailer = value; return this; }
        public String getTitle() { return title; }
        public LinkResult setTitle(String value) { this.title = value; return this; }
        public String getAuthor() { return author; }
        public LinkResult setAuthor(String value) { this.author = value; return this; }
    }

}

Java GetLinksRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}