CollectionsAPI

<back to all web services

PostCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections/settings
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CollectionsAPI.ServiceModel.V4.Requests
Imports CollectionsAPI.Contracts.DTOs
Imports CollectionsAPI.ServiceModel.V4.Responses

Namespace Global

    Namespace CollectionsAPI.Contracts.DTOs

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

    Namespace CollectionsAPI.ServiceModel.V4.Requests

        <DataContract>
        Public Partial Class CollectionSettingsBaseRequest
            Inherits V4BaseRequest
            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 PostCollectionSettingsRequest
            Inherits CollectionSettingsBaseRequest
            Implements IPostCollectionSettingsRequest
        End Class

        <DataContract>
        Public Partial Class V4BaseRequest
        End Class
    End Namespace

    Namespace CollectionsAPI.ServiceModel.V4.Responses

        <DataContract>
        Public Partial Class PostCollectionSettingsResponse
            Inherits V4BaseResponse
            Implements IPostCollectionSettingsResponse
        End Class

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

VB.NET PostCollectionSettingsRequest DTOs

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

HTTP + CSV

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

POST /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"profileImageId":"String","signatureImageId":"String","signatureText":"String","signatureFont":"String","signatureAppearance":"none"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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