Booklinker.API

<back to all web services

PutLinkUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/links
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
{

    public static class PutLinkUpdateRequest
    {
        @DataMember(Name="baseCode")
        @SerializedName("baseCode")
        public String baseCode = null;

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

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

        @DataMember(Name="url")
        @SerializedName("url")
        public String newUrl = null;
        
        public String getBaseCode() { return baseCode; }
        public PutLinkUpdateRequest setBaseCode(String value) { this.baseCode = value; return this; }
        public String getDomain() { return domain; }
        public PutLinkUpdateRequest setDomain(String value) { this.domain = value; return this; }
        public String getVanityCode() { return vanityCode; }
        public PutLinkUpdateRequest setVanityCode(String value) { this.vanityCode = value; return this; }
        public String getNewUrl() { return newUrl; }
        public PutLinkUpdateRequest setNewUrl(String value) { this.newUrl = value; return this; }
    }

    @DataContract
    public static class PutLinkUpdateResponse
    {
        @DataMember(Name="success")
        @SerializedName("success")
        public Boolean success = null;

        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public Boolean isSuccess() { return success; }
        public PutLinkUpdateResponse setSuccess(Boolean value) { this.success = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PutLinkUpdateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java PutLinkUpdateRequest 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 /v1/links HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	baseCode: String,
	domain: String,
	code: String,
	url: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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