Booklinker.API

PostLinkCreationRequest

The following routes are available for this service:
POST	/v1/links
POST	/v1/complete-link-creation-requests

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class PostLinkCreationRequest : PostLinkCreationRequestBase()
{
    @DataMember(Name="code")
    @SerializedName("code")
    open var code:String? = null
}

@DataContract
open class PostLinkCreationRequestBase
{
    @DataMember(Name="url")
    @SerializedName("url")
    @ApiMember(IsRequired=true)
    open var url:String? = null

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

    @DataMember(Name="parameterKeyValues")
    @SerializedName("parameterKeyValues")
    open var parameterKeyValues:HashMap<String,String>? = null
}

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

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

    @DataMember(Name="destinations")
    @SerializedName("destinations")
    open var destinations:ArrayList<ProductMetadata>? = null

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

@DataContract
open class ProductMetadata : ProductMetadata()
{
}

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

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

    @DataMember(Name="url")
    @SerializedName("url")
    open var url:Uri? = null

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

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

    @DataMember(Name="productImages")
    @SerializedName("productImages")
    open var productImages:HashMap<String,Uri>? = null
}

Kotlin PostLinkCreationRequest 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.

POST /v1/links HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	code: String,
	url: String,
	domain: String,
	parameterKeyValues: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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