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.*;

public class dtos
{

    @DataContract
    public static class PutCollectionRequest extends V2BaseRequest
    {
        @DataMember(Name="id")
        @SerializedName("id")
        public String id = null;

        @DataMember(Name="title")
        @SerializedName("title")
        public String title = null;

        @DataMember(Name="linkIds")
        @SerializedName("linkIds")
        public ArrayList<String> linkIds = null;
        
        public String getId() { return id; }
        public PutCollectionRequest setId(String value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public PutCollectionRequest setTitle(String value) { this.title = value; return this; }
        public ArrayList<String> getLinkIds() { return linkIds; }
        public PutCollectionRequest setLinkIds(ArrayList<String> value) { this.linkIds = value; return this; }
    }

    @DataContract
    public static class V2BaseRequest
    {
        
    }

    @DataContract
    public static class PutCollectionResponse extends V2BaseResponse
    {
        
    }

    @DataContract
    public static class V2BaseResponse
    {
        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public V2BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

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