Booklinker.API

<back to all web services

GetAccountRequest

Requires Authentication
The following routes are available for this service:
GET/v1/account
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V2.Requests
Imports Booklinker.API.ServiceModel.V2.Responses
Imports Booklinker.API.ServiceModel.DTOs.V2
Imports ImageServiceAPI.Contracts.V4.DTOs
Imports CollectionsAPI.Contracts.DTOs

Namespace Global

    Namespace Booklinker.API.ServiceModel.DTOs.V2

        <DataContract>
        Public Partial Class AccountData
            <DataMember(Name:="id")>
            Public Overridable Property Id As String

            <DataMember(Name:="userId")>
            Public Overridable Property UserId As String

            <DataMember(Name:="emailAddress")>
            Public Overridable Property EmailAddress As String

            <DataMember(Name:="fullName")>
            Public Overridable Property FullName As String

            <DataMember(Name:="profileImage")>
            Public Overridable Property ProfileImage As IImageData

            <DataMember(Name:="signatureImage")>
            Public Overridable Property SignatureImage As IImageData

            <DataMember(Name:="signatureFont")>
            Public Overridable Property SignatureFont As String

            <DataMember(Name:="signatureAppearance")>
            Public Overridable Property SignatureAppearance As SignatureAppearance
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Requests

        <DataContract>
        Public Partial Class GetAccountRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class GetAccountResponse
            Inherits V2BaseResponse
            <DataMember(Name:="data")>
            Public Overridable Property Data As AccountData
        End Class

        <DataContract>
        Public Partial Class V2BaseResponse
            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace CollectionsAPI.Contracts.DTOs

        Public Enum SignatureAppearance
            <EnumMember(Value:="none")>
            None
            <EnumMember(Value:="text")>
            Text
            <EnumMember(Value:="upload")>
            Upload
        End Enum
    End Namespace

    Namespace ImageServiceAPI.Contracts.V4.DTOs

        Public Interface IImageData
            Property Id As String
            Property Provider As String
            Property ProviderImageId As String
            Property Url As String
            Property Attributes As Dictionary(Of String, String)
        End Interface
    End Namespace
End Namespace

VB.NET GetAccountRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}