CollectionsAPI

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections
namespace CollectionsAPI.Contracts.V4.Responses

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

    [<AllowNullLiteral>]
    type IPostCollectionResponseData = 
        abstract Id:String with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PostCollectionResponse() = 
        inherit V4BaseResponse()
        [<DataMember(Name="data")>]
        member val Data:IPostCollectionResponseData = null with get,set

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type PostCollectionRequest() = 
        inherit V4BaseRequest()
        [<DataMember(Name="title")>]
        member val Title:String = null with get,set

        [<DataMember(Name="linkIds")>]
        member val LinkIds:IEnumerable<String> = null with get,set

        [<DataMember(Name="collectionSettingsId")>]
        member val CollectionSettingsId:String = null with get,set

F# PostCollectionRequest 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.

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"title":"String","collectionSettingsId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}