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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class PutCollectionSettingsRequest : CollectionSettingsBaseRequest(), IPutCollectionSettingsRequest
{
    @DataMember(Name="id")
    @SerializedName("id")
    override var id:String? = null
}

@DataContract
open class CollectionSettingsBaseRequest : V4BaseRequest(), ICollectionSettingsBaseRequest
{
    @DataMember(Name="profileImageId")
    @SerializedName("profileImageId")
    override var profileImageId:String? = null

    @DataMember(Name="signatureImageId")
    @SerializedName("signatureImageId")
    override var signatureImageId:String? = null

    @DataMember(Name="signatureText")
    @SerializedName("signatureText")
    override var signatureText:String? = null

    @DataMember(Name="signatureFont")
    @SerializedName("signatureFont")
    override var signatureFont:String? = null

    @DataMember(Name="signatureAppearance")
    @SerializedName("signatureAppearance")
    override var signatureAppearance:SignatureAppearance? = null
}

@DataContract
open class V4BaseRequest
{
}

enum class SignatureAppearance
{
    None,
    Text,
    Upload,
}

@DataContract
open class PutCollectionSettingsResponse : V4BaseResponse()
{
}

@DataContract
open class V4BaseResponse
{
    @DataMember(Name="status")
    @SerializedName("status")
    open var responseStatus:ResponseStatus? = null
}

Kotlin 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"}}}