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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CollectionsAPI.ServiceModel.V4.Requests;
using CollectionsAPI.Contracts.DTOs;
using CollectionsAPI.ServiceModel.V4.Responses;

namespace CollectionsAPI.Contracts.DTOs
{
    public enum SignatureAppearance
    {
        [EnumMember(Value="none")]
        None,
        [EnumMember(Value="text")]
        Text,
        [EnumMember(Value="upload")]
        Upload,
    }

}

namespace CollectionsAPI.ServiceModel.V4.Requests
{
    [DataContract]
    public partial class CollectionSettingsBaseRequest
        : V4BaseRequest, ICollectionSettingsBaseRequest
    {
        [DataMember(Name="profileImageId")]
        public virtual string ProfileImageId { get; set; }

        [DataMember(Name="signatureImageId")]
        public virtual string SignatureImageId { get; set; }

        [DataMember(Name="signatureText")]
        public virtual string SignatureText { get; set; }

        [DataMember(Name="signatureFont")]
        public virtual string SignatureFont { get; set; }

        [DataMember(Name="signatureAppearance")]
        public virtual SignatureAppearance SignatureAppearance { get; set; }
    }

    [DataContract]
    public partial class PutCollectionSettingsRequest
        : CollectionSettingsBaseRequest, IPutCollectionSettingsRequest
    {
        [DataMember(Name="id")]
        public virtual string Id { get; set; }
    }

    [DataContract]
    public partial class V4BaseRequest
    {
    }

}

namespace CollectionsAPI.ServiceModel.V4.Responses
{
    [DataContract]
    public partial class PutCollectionSettingsResponse
        : V4BaseResponse
    {
    }

    [DataContract]
    public partial class V4BaseResponse
    {
        [DataMember(Name="status")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}