Booklinker.API

<back to all web services

GetAccountRequest

Requires Authentication
The following routes are available for this service:
GET/v1/account
GetAccountResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAccountDataNo
V2BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AccountData Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UserIdformstringNo
EmailAddressformstringNo
FullNameformstringNo
ProfileImageformIImageDataNo
SignatureImageformIImageDataNo
SignatureFontformstringNo
SignatureAppearanceformSignatureAppearanceNo
IImageData Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ProviderformstringNo
ProviderImageIdformstringNo
UrlformstringNo
AttributesformDictionary<string, string>No
SignatureAppearance Enum:
NameValue
Nonenone
Texttext
Uploadupload

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