CollectionsAPI

GetCollectionsRequest

The following routes are available for this service:
GET	/v4/collections/list

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CollectionsAPI.ServiceModel.V4.Requests;
using CollectionsAPI.ServiceModel.V4.Responses;
using CollectionsAPI.Contracts.DTOs;

namespace CollectionsAPI.Contracts.DTOs
{
    public partial interface IUserCollection
    {
        string Id { get; set; }
        string Title { get; set; }
        IEnumerable<string> LinkIds { get; set; }
        string CollectionSettingsId { get; set; }
    }

}

namespace CollectionsAPI.ServiceModel.V4.Requests
{
    [DataContract]
    public partial class GetCollectionsRequest
        : V4ListRequest
    {
    }

    [DataContract]
    public partial class V4BaseRequest
    {
    }

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

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

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

}

namespace CollectionsAPI.ServiceModel.V4.Responses
{
    [DataContract]
    public partial class GetCollectionsResponse
        : V4PaginatedBaseResponse, IGetCollectionsResponse
    {
        [DataMember(Name="data")]
        public virtual IEnumerable<IUserCollection> Data { get; set; }
    }

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

    [DataContract]
    public partial class V4PageObject
    {
        [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 V4PaginatedBaseResponse
        : V4BaseResponse
    {
        [DataMember(Name="page")]
        public virtual V4PageObject Page { get; set; }
    }

}

C# GetCollectionsRequest DTOs

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

HTTP + OTHER

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

GET /v4/collections/list HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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