Booklinker.API

<back to all web services

PutAccountRequest

Requires Authentication
The following routes are available for this service:
PUT/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 CollectionsAPI.Contracts.DTOs
Imports Booklinker.API.ServiceModel.V2.Responses

Namespace Global

    Namespace Booklinker.API.ServiceModel.V2.Requests

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

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

            <DataMember(Name:="profileImageId")>
            Public Overridable Property ProfileImageId As String

            <DataMember(Name:="signatureImageId")>
            Public Overridable Property SignatureImageId As String

            <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.Responses

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

        <DataContract>
        Public Partial Class PutAccountResponseData
            <DataMember(Name:="oneTimeToken")>
            Public Overridable Property OneTimeToken As String
        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
End Namespace

VB.NET PutAccountRequest 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.

PUT /v1/account HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	newEmail: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	oneTimeToken: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}