CollectionsAPI

<back to all web services

PutCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
PUT/v4/collections/settings
PUT/v4/collections/settings/{Id}
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 PutCollectionSettingsResponse() = 
        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 PutCollectionSettingsRequest() = 
        inherit CollectionSettingsBaseRequest()
        [<DataMember(Name="id")>]
        member val Id:String = null with get,set

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

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

{"id":"String","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"}}}