Booklinker.API

<back to all web services

GetCollectionSettingsRequest

Requires Authentication
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;

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

}

namespace Booklinker.API.ServiceModel.V2.Responses
{
    [DataContract]
    public partial class GetCollectionsResponse
        : V2PaginatedBaseResponse, IGetCollectionsResponse
    {
    }

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

    [DataContract]
    public partial class V2PageObject
    {
        [DataMember(Name="offset")]
        public virtual int Offset { get; set; }

        [DataMember(Name="limit")]
        public virtual int Limit { get; set; }

        [DataMember(Name="totalRecords")]
        public virtual int TotalRecords { get; set; }
    }

    [DataContract]
    public partial class V2PaginatedBaseResponse
        : V2BaseResponse
    {
        [DataMember(Name="page")]
        public virtual V2PageObject Page { get; set; }
    }

}

C# GetCollectionSettingsRequest 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.

POST /jsv/reply/GetCollectionSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	page: 
	{
		offset: 0,
		limit: 0,
		totalRecords: 0
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}