CollectionsAPI

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class PostCollectionRequest : V4BaseRequest(), IPostCollectionRequest
{
    @DataMember(Name="title")
    @SerializedName("title")
    override var title:String? = null

    @DataMember(Name="linkIds")
    @SerializedName("linkIds")
    override var linkIds:ArrayList<String>? = null

    @DataMember(Name="collectionSettingsId")
    @SerializedName("collectionSettingsId")
    override var collectionSettingsId:String? = null
}

@DataContract
open class V4BaseRequest
{
}

@DataContract
open class PostCollectionResponse : V4BaseResponse(), IPostCollectionResponse
{
    @DataMember(Name="data")
    @SerializedName("data")
    override var Data:IPostCollectionResponseData? = null
}

@DataContract
open class V4BaseResponse
{
    @DataMember(Name="status")
    @SerializedName("status")
    open var responseStatus:ResponseStatus? = null
}

interface IPostCollectionResponseData
{
    var id:String?
}

Kotlin 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"}}}