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


@DataContract
open class GetVanityCodeAvailabilityRequest
{
    @DataMember(Name="code")
    @SerializedName("code")
    open var code:String? = null

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

@DataContract
open class GetVanityCodeAvailabilityResponse
{
    @DataMember(Name="isAvailable")
    @SerializedName("isAvailable")
    open var isAvailable:Boolean? = null

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

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