CollectionsAPI

PutCollectionSettingsRequest

The following routes are available for this service:
PUT	/v4/collections/settings
PUT	/v4/collections/settings/{Id}

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 PutCollectionSettingsRequest
            Inherits CollectionSettingsBaseRequest
            Implements IPutCollectionSettingsRequest
            <DataMember(Name:="id")>
            Public Overridable Property Id As String Implements IPutCollectionSettingsRequest.Id
        End Class

        <DataContract>
        Public Partial Class V4BaseRequest
        End Class
    End Namespace

    Namespace CollectionsAPI.ServiceModel.V4.Responses

        <DataContract>
        Public Partial Class PutCollectionSettingsResponse
            Inherits V4BaseResponse
        End Class

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

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

PUT /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutCollectionSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Requests">
  <profileImageId>String</profileImageId>
  <signatureAppearance>None</signatureAppearance>
  <signatureFont>String</signatureFont>
  <signatureImageId>String</signatureImageId>
  <signatureText>String</signatureText>
  <id>String</id>
</PutCollectionSettingsRequest>

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

<PutCollectionSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <status 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>
  </status>
</PutCollectionSettingsResponse>