Booklinker.API

GetCollectionRequest

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

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.V2.Requests
Imports Booklinker.API.ServiceModel.V2.Responses
Imports Booklinker.API.ServiceModel.DTOs.V2

Namespace Global

    Namespace Booklinker.API.ServiceModel.DTOs.V2

        <DataContract>
        Public Partial Class UserCollection
            Implements IUserCollection
            <DataMember(Name:="type")>
            Public Overridable Property Type As String

            <DataMember(Name:="id")>
            Public Overridable Property Id As String Implements IUserCollection.Id

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

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

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

            <DataMember(Name:="linkIds")>
            Public Overridable Property LinkIds As IEnumerable(Of String) Implements IUserCollection.LinkIds

            <DataMember(Name:="collectionSettingsId")>
            Public Overridable Property CollectionSettingsId As String Implements IUserCollection.CollectionSettingsId
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Requests

        <DataContract>
        Public Partial Class GetCollectionRequest
            Inherits V2BaseRequest
            <DataMember(Name:="id")>
            Public Overridable Property Id As String
        End Class

        <DataContract>
        Public Partial Class V2BaseRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class GetCollectionResponse
            Inherits V2BaseResponse
            <DataMember(Name:="data")>
            Public Overridable Property Data As UserCollection
        End Class

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

VB.NET 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
		}
	}
}