Booklinker.API

GetLinksRequest

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V1.Requests
Imports Booklinker.API.ServiceModel.V1.Responses
Imports Booklinker.API.ServiceModel.DTOs.Shortlinks

Namespace Global

    Namespace Booklinker.API.ServiceModel.DTOs.Shortlinks

        <DataContract>
        Public Partial Class LinkResult
            <DataMember(Name:="baseCode")>
            Public Overridable Property BaseCode As String

            <DataMember(Name:="url")>
            Public Overridable Property Url As String

            <DataMember(Name:="originalUrl")>
            Public Overridable Property OriginalUrl As String

            <DataMember(Name:="imageUrl")>
            Public Overridable Property ImageUrl As String

            <DataMember(Name:="retailer")>
            Public Overridable Property Retailer As String

            <DataMember(Name:="title")>
            Public Overridable Property Title As String

            <DataMember(Name:="author")>
            Public Overridable Property Author As String
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.Requests

        <DataContract>
        Public Partial Class GetLinksRequest
            Inherits PaginatedBaseRequest
            <DataMember(Name:="ids")>
            Public Overridable Property Ids As List(Of String)
        End Class

        <DataContract>
        Public Partial Class PaginatedBaseRequest
            <DataMember(Name:="skip")>
            Public Overridable Property Skip As Integer

            <DataMember(Name:="take")>
            Public Overridable Property Take As Integer
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.Responses

        <DataContract>
        Public Partial Class GetLinksResponse
            <DataMember(Name:="allLinksLoaded")>
            Public Overridable Property AllLinksLoaded As Boolean

            <DataMember(Name:="results")>
            Public Overridable Property Results As List(Of LinkResult)

            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetLinksRequest 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 /v1/links/list HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

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