Booklinker.API

<back to all web services

SignUpRequest

The following routes are available for this service:
POST/v1/signup
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 SignUpRequest
{
    @DataMember(Name="email")
    @SerializedName("email")
    @ApiMember(IsRequired=true, Name="email")
    open var email:String? = null

    @DataMember(Name="url")
    @SerializedName("url")
    @ApiMember(IsRequired=true, Name="url")
    open var url:String? = null

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

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

    @DataMember(Name="affiliateProgramGuid")
    @SerializedName("affiliateProgramGuid")
    open var affiliateProgramGuid:UUID? = null

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

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

    @DataMember(Name="hasAccount")
    @SerializedName("hasAccount")
    open var hasAccount:Boolean? = null

    @DataMember(Name="accountConfirmed")
    @SerializedName("accountConfirmed")
    open var accountConfirmed:Boolean? = null

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

Kotlin SignUpRequest 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/signup HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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