Booklinker.API

<back to all web services

GetVanityCodeAvailabilityRequest

The following routes are available for this service:
GET/v1/vanity-codes/availability
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 GetVanityCodeAvailabilityRequest
    {
        @DataMember(Name="code")
        @SerializedName("code")
        public String code = null;

        @DataMember(Name="domain")
        @SerializedName("domain")
        public String domain = null;
        
        public String getCode() { return code; }
        public GetVanityCodeAvailabilityRequest setCode(String value) { this.code = value; return this; }
        public String getDomain() { return domain; }
        public GetVanityCodeAvailabilityRequest setDomain(String value) { this.domain = value; return this; }
    }

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

        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public Boolean getIsAvailable() { return isAvailable; }
        public GetVanityCodeAvailabilityResponse setIsAvailable(Boolean value) { this.isAvailable = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetVanityCodeAvailabilityResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java GetVanityCodeAvailabilityRequest 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.

GET /v1/vanity-codes/availability HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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