CollectionsAPI

<back to all web services

GetCollectionsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/collections/list
namespace CollectionsAPI.Contracts.DTOs

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4BaseResponse() = 
        [<DataMember(Name="status")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4PageObject() = 
        [<DataMember(Name="offset")>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Name="limit")>]
        member val Limit:Int32 = new Int32() with get,set

        [<DataMember(Name="totalRecords")>]
        member val TotalRecords:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4PaginatedBaseResponse() = 
        inherit V4BaseResponse()
        [<DataMember(Name="page")>]
        member val Page:V4PageObject = null with get,set

    [<AllowNullLiteral>]
    type IUserCollection = 
        abstract Id:String with get,set
        abstract Title:String with get,set
        abstract LinkIds:IEnumerable<String> with get,set
        abstract CollectionSettingsId:String with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetCollectionsResponse() = 
        inherit V4PaginatedBaseResponse()
        [<DataMember(Name="data")>]
        member val Data:IEnumerable<IUserCollection> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4BaseRequest() = 
        class end

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4PaginatedBaseRequest() = 
        inherit V4BaseRequest()
        [<DataMember(Name="offset")>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Name="limit")>]
        member val Limit:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4ListRequest() = 
        inherit V4PaginatedBaseRequest()
        [<DataMember(Name="ids")>]
        member val Ids:ResizeArray<String> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetCollectionsRequest() = 
        inherit V4ListRequest()

F# 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"}}}