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.*;

public class dtos
{

    @DataContract
    public static class GetAccountRequest
    {
        
    }

    @DataContract
    public static class GetAccountResponse extends V2BaseResponse
    {
        @DataMember(Name="data")
        @SerializedName("data")
        public AccountData data = null;
        
        public AccountData getData() { return data; }
        public GetAccountResponse setData(AccountData value) { this.data = value; return this; }
    }

    @DataContract
    public static class V2BaseResponse
    {
        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public V2BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class AccountData
    {
        @DataMember(Name="id")
        @SerializedName("id")
        public String id = null;

        @DataMember(Name="userId")
        @SerializedName("userId")
        public String userId = null;

        @DataMember(Name="emailAddress")
        @SerializedName("emailAddress")
        public String emailAddress = null;

        @DataMember(Name="fullName")
        @SerializedName("fullName")
        public String fullName = null;

        @DataMember(Name="profileImage")
        @SerializedName("profileImage")
        public IImageData profileImage = null;

        @DataMember(Name="signatureImage")
        @SerializedName("signatureImage")
        public IImageData signatureImage = null;

        @DataMember(Name="signatureFont")
        @SerializedName("signatureFont")
        public String signatureFont = null;

        @DataMember(Name="signatureAppearance")
        @SerializedName("signatureAppearance")
        public SignatureAppearance signatureAppearance = null;
        
        public String getId() { return id; }
        public AccountData setId(String value) { this.id = value; return this; }
        public String getUserId() { return userId; }
        public AccountData setUserId(String value) { this.userId = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public AccountData setEmailAddress(String value) { this.emailAddress = value; return this; }
        public String getFullName() { return fullName; }
        public AccountData setFullName(String value) { this.fullName = value; return this; }
        public IImageData getProfileImage() { return profileImage; }
        public AccountData setProfileImage(IImageData value) { this.profileImage = value; return this; }
        public IImageData getSignatureImage() { return signatureImage; }
        public AccountData setSignatureImage(IImageData value) { this.signatureImage = value; return this; }
        public String getSignatureFont() { return signatureFont; }
        public AccountData setSignatureFont(String value) { this.signatureFont = value; return this; }
        public SignatureAppearance getSignatureAppearance() { return signatureAppearance; }
        public AccountData setSignatureAppearance(SignatureAppearance value) { this.signatureAppearance = value; return this; }
    }

    public static interface IImageData
    {
        public String id = null;
        public String provider = null;
        public String providerImageId = null;
        public String url = null;
        public HashMap<String,String> attributes = null;
    }

    public static enum SignatureAppearance
    {
        None,
        Text,
        Upload;
    }

}

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