Booklinker.API

GetAccountRequest

The following routes are available for this service:
GET	/v1/account


// @DataContract
export class V2BaseResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<V2BaseResponse>) { (Object as any).assign(this, init); }
}

export interface IImageData
{
    id: string;
    provider: string;
    providerImageId: string;
    url: string;
    attributes: { [index:string]: string; };
}

export enum SignatureAppearance
{
    None = 'none',
    Text = 'text',
    Upload = 'upload',
}

// @DataContract
export class AccountData
{
    // @DataMember(Name="id")
    public id: string;

    // @DataMember(Name="userId")
    public userId: string;

    // @DataMember(Name="emailAddress")
    public emailAddress: string;

    // @DataMember(Name="fullName")
    public fullName: string;

    // @DataMember(Name="profileImage")
    public profileImage: IImageData;

    // @DataMember(Name="signatureImage")
    public signatureImage: IImageData;

    // @DataMember(Name="signatureFont")
    public signatureFont: string;

    // @DataMember(Name="signatureAppearance")
    public signatureAppearance: SignatureAppearance;

    public constructor(init?: Partial<AccountData>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAccountResponse extends V2BaseResponse
{
    // @DataMember(Name="data")
    public data: AccountData;

    public constructor(init?: Partial<GetAccountResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetAccountRequest
{

    public constructor(init?: Partial<GetAccountRequest>) { (Object as any).assign(this, init); }
}

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