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.*;

public class dtos
{

    @DataContract
    public static class PutCollectionSettingsRequest extends CollectionSettingsBaseRequest implements IPutCollectionSettingsRequest
    {
        @DataMember(Name="id")
        @SerializedName("id")
        public String id = null;
        
        public String getId() { return id; }
        public PutCollectionSettingsRequest setId(String value) { this.id = value; return this; }
    }

    @DataContract
    public static class CollectionSettingsBaseRequest extends V4BaseRequest implements ICollectionSettingsBaseRequest
    {
        @DataMember(Name="profileImageId")
        @SerializedName("profileImageId")
        public String profileImageId = null;

        @DataMember(Name="signatureImageId")
        @SerializedName("signatureImageId")
        public String signatureImageId = null;

        @DataMember(Name="signatureText")
        @SerializedName("signatureText")
        public String signatureText = null;

        @DataMember(Name="signatureFont")
        @SerializedName("signatureFont")
        public String signatureFont = null;

        @DataMember(Name="signatureAppearance")
        @SerializedName("signatureAppearance")
        public SignatureAppearance signatureAppearance = null;
        
        public String getProfileImageId() { return profileImageId; }
        public CollectionSettingsBaseRequest setProfileImageId(String value) { this.profileImageId = value; return this; }
        public String getSignatureImageId() { return signatureImageId; }
        public CollectionSettingsBaseRequest setSignatureImageId(String value) { this.signatureImageId = value; return this; }
        public String getSignatureText() { return signatureText; }
        public CollectionSettingsBaseRequest setSignatureText(String value) { this.signatureText = value; return this; }
        public String getSignatureFont() { return signatureFont; }
        public CollectionSettingsBaseRequest setSignatureFont(String value) { this.signatureFont = value; return this; }
        public SignatureAppearance getSignatureAppearance() { return signatureAppearance; }
        public CollectionSettingsBaseRequest setSignatureAppearance(SignatureAppearance value) { this.signatureAppearance = value; return this; }
    }

    @DataContract
    public static class V4BaseRequest
    {
        
    }

    public static enum SignatureAppearance
    {
        None,
        Text,
        Upload;
    }

    @DataContract
    public static class PutCollectionSettingsResponse extends V4BaseResponse
    {
        
    }

    @DataContract
    public static class V4BaseResponse
    {
        @DataMember(Name="status")
        @SerializedName("status")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public V4BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java PutCollectionSettingsRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

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

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