Booklinker.API

<back to all web services

GetCollectionRequest

Requires Authentication
The following routes are available for this service:
GET/v2/collections
GET/v2/collections/{Id}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Booklinker.API.ServiceModel.V2.Requests;
using Booklinker.API.ServiceModel.V2.Responses;
using Booklinker.API.ServiceModel.DTOs.V2;

namespace Booklinker.API.ServiceModel.DTOs.V2
{
    [DataContract]
    public partial class UserCollection
        : IUserCollection
    {
        [DataMember(Name="type")]
        public virtual string Type { get; set; }

        [DataMember(Name="id")]
        public virtual string Id { get; set; }

        [DataMember(Name="baseCode")]
        public virtual string BaseCode { get; set; }

        [DataMember(Name="url")]
        public virtual string Url { get; set; }

        [DataMember(Name="title")]
        public virtual string Title { get; set; }

        [DataMember(Name="linkIds")]
        public virtual IEnumerable<string> LinkIds { get; set; }

        [DataMember(Name="collectionSettingsId")]
        public virtual string CollectionSettingsId { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V2.Requests
{
    [DataContract]
    public partial class GetCollectionRequest
        : V2BaseRequest
    {
        [DataMember(Name="id")]
        public virtual string Id { get; set; }
    }

    [DataContract]
    public partial class V2BaseRequest
    {
    }

}

namespace Booklinker.API.ServiceModel.V2.Responses
{
    [DataContract]
    public partial class GetCollectionResponse
        : V2BaseResponse
    {
        [DataMember(Name="data")]
        public virtual UserCollection Data { get; set; }
    }

    [DataContract]
    public partial class V2BaseResponse
    {
        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}