CollectionsAPI

<back to all web services

PostCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections/settings
namespace CollectionsAPI.Contracts.DTOs

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4BaseResponse() = 
        [<DataMember(Name="status")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PostCollectionSettingsResponse() = 
        inherit V4BaseResponse()

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4BaseRequest() = 
        class end

    type SignatureAppearance =
        | None = 0
        | Text = 1
        | Upload = 2

    [<DataContract>]
    [<AllowNullLiteral>]
    type CollectionSettingsBaseRequest() = 
        inherit V4BaseRequest()
        [<DataMember(Name="profileImageId")>]
        member val ProfileImageId:String = null with get,set

        [<DataMember(Name="signatureImageId")>]
        member val SignatureImageId:String = null with get,set

        [<DataMember(Name="signatureText")>]
        member val SignatureText:String = null with get,set

        [<DataMember(Name="signatureFont")>]
        member val SignatureFont:String = null with get,set

        [<DataMember(Name="signatureAppearance")>]
        member val SignatureAppearance:SignatureAppearance = new SignatureAppearance() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PostCollectionSettingsRequest() = 
        inherit CollectionSettingsBaseRequest()

F# PostCollectionSettingsRequest 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.

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

<PostCollectionSettingsRequest 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>
</PostCollectionSettingsRequest>

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

<PostCollectionSettingsResponse 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>
  <data i:nil="true" />
</PostCollectionSettingsResponse>