Booklinker.API

<back to all web services

GetCollectionsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/collections/list
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 GetCollectionsRequest
        : V2ListRequest
    {
    }

    [DataContract]
    public partial class V2BaseRequest
    {
    }

    [DataContract]
    public partial class V2ListRequest
        : V2PaginatedBaseRequest
    {
        [DataMember(Name="ids")]
        public virtual List<string> Ids { get; set; }
    }

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

        [DataMember(Name="limit")]
        public virtual int Limit { 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# GetCollectionsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v2/collections/list HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}