Booklinker.API

<back to all web services

GetAccountRequest

Requires Authentication
The following routes are available for this service:
GET/v1/account
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 GetAccountRequest
{
}

@DataContract
open class GetAccountResponse : V2BaseResponse()
{
    @DataMember(Name="data")
    @SerializedName("data")
    open var Data:AccountData? = null
}

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

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

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

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

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

    @DataMember(Name="profileImage")
    @SerializedName("profileImage")
    open var profileImage:IImageData? = null

    @DataMember(Name="signatureImage")
    @SerializedName("signatureImage")
    open var signatureImage:IImageData? = null

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

    @DataMember(Name="signatureAppearance")
    @SerializedName("signatureAppearance")
    open var signatureAppearance:SignatureAppearance? = null
}

interface IImageData
{
    var id:String?
    var provider:String?
    var providerImageId:String?
    var url:String?
    var attributes:HashMap<String,String>?
}

enum class SignatureAppearance
{
    None,
    Text,
    Upload,
}

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

{
	userAccount: 
	{
		email: String,
		settings: 
		{
			id: String,
			profileImageId: String,
			signatureImageId: String,
			signatureText: String,
			signatureFont: String,
			signatureAppearance: none
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}