Booklinker.API

<back to all web services

GetAccountRequest

Requires Authentication
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
  <userAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.Models">
    <d2p1:email>String</d2p1:email>
    <d2p1:settings xmlns:d3p1="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.DTOs.V2">
      <d3p1:id>String</d3p1:id>
      <d3p1:profileImageId>String</d3p1:profileImageId>
      <d3p1:signatureAppearance>None</d3p1:signatureAppearance>
      <d3p1:signatureFont>String</d3p1:signatureFont>
      <d3p1:signatureImageId>String</d3p1:signatureImageId>
      <d3p1:signatureText>String</d3p1:signatureText>
    </d2p1:settings>
  </userAccount>
</GetAccountResponse>