Booklinker.API

<back to all web services

PutCollectionRequest

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

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

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

@DataContract
open class V2BaseRequest
{
}

@DataContract
open class PutCollectionResponse : V2BaseResponse()
{
}

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

Kotlin PutCollectionRequest DTOs

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

HTTP + JSV

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

PUT /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	title: String,
	linkIds: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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