Booklinker.API

<back to all web services

PutCollectionSettingsRequest

Requires Authentication 
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 CollectionSettingsBaseRequest
            Inherits V2BaseRequest
            Implements ICollectionSettingsBaseRequest
            <DataMember(Name:="profileImageId")>
            Public Overridable Property ProfileImageId As String Implements ICollectionSettingsBaseRequest.ProfileImageId

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

            <DataMember(Name:="signatureText")>
            Public Overridable Property SignatureText As String Implements ICollectionSettingsBaseRequest.SignatureText

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

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

        <DataContract>
        Public Partial Class PutCollectionSettingsRequest
            Inherits CollectionSettingsBaseRequest
            Implements IPutCollectionSettingsRequest
            <DataMember(Name:="id")>
            Public Overridable Property Id As String Implements IPutCollectionSettingsRequest.Id
        End Class

        <DataContract>
        Public Partial Class V2BaseRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class PutCollectionSettingsResponse
            Inherits V2BaseResponse
        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 PutCollectionSettingsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/PutCollectionSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","profileImageId":"String","signatureImageId":"String","signatureText":"String","signatureFont":"String","signatureAppearance":"none"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}