Booklinker.API

<back to all web services

GetCollectionRequest

Requires Authentication
The following routes are available for this service:
GET/v2/collections
GET/v2/collections/{Id}
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 GetCollectionRequest : V2BaseRequest()
{
    @DataMember(Name="id")
    @SerializedName("id")
    open var id:String? = null
}

@DataContract
open class V2BaseRequest
{
}

@DataContract
open class GetCollectionResponse : V2BaseResponse()
{
    @DataMember(Name="data")
    @SerializedName("data")
    open var Data:UserCollection? = null
}

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

@DataContract
open class UserCollection : IUserCollection
{
    @DataMember(Name="type")
    @SerializedName("type")
    open var Type:String? = null

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

    @DataMember(Name="baseCode")
    @SerializedName("baseCode")
    open var baseCode:String? = null

    @DataMember(Name="url")
    @SerializedName("url")
    open var url:String? = null

    @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
}

Kotlin GetCollectionRequest 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 HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"type":"collection","id":"String","baseCode":"String","url":"String","title":"String","collectionSettingsId":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}