CollectionsAPI

<back to all web services

PostCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections/settings
import Foundation
import ServiceStack

// @DataContract
public class PostCollectionSettingsRequest : CollectionSettingsBaseRequest, IPostCollectionSettingsRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class CollectionSettingsBaseRequest : V4BaseRequest, ICollectionSettingsBaseRequest
{
    // @DataMember(Name="profileImageId")
    public var profileImageId:String

    // @DataMember(Name="signatureImageId")
    public var signatureImageId:String

    // @DataMember(Name="signatureText")
    public var signatureText:String

    // @DataMember(Name="signatureFont")
    public var signatureFont:String

    // @DataMember(Name="signatureAppearance")
    public var signatureAppearance:SignatureAppearance

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case profileImageId
        case signatureImageId
        case signatureText
        case signatureFont
        case signatureAppearance
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        profileImageId = try container.decodeIfPresent(String.self, forKey: .profileImageId)
        signatureImageId = try container.decodeIfPresent(String.self, forKey: .signatureImageId)
        signatureText = try container.decodeIfPresent(String.self, forKey: .signatureText)
        signatureFont = try container.decodeIfPresent(String.self, forKey: .signatureFont)
        signatureAppearance = try container.decodeIfPresent(SignatureAppearance.self, forKey: .signatureAppearance)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if profileImageId != nil { try container.encode(profileImageId, forKey: .profileImageId) }
        if signatureImageId != nil { try container.encode(signatureImageId, forKey: .signatureImageId) }
        if signatureText != nil { try container.encode(signatureText, forKey: .signatureText) }
        if signatureFont != nil { try container.encode(signatureFont, forKey: .signatureFont) }
        if signatureAppearance != nil { try container.encode(signatureAppearance, forKey: .signatureAppearance) }
    }
}

// @DataContract
public class V4BaseRequest : Codable
{
    required public init(){}
}

public enum SignatureAppearance : String, Codable
{
    case None
    case Text
    case Upload
}

// @DataContract
public class PostCollectionSettingsResponse : V4BaseResponse, IPostCollectionSettingsResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class V4BaseResponse : Codable
{
    // @DataMember(Name="status")
    public var status:ResponseStatus

    required public init(){}
}


Swift PostCollectionSettingsRequest 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.

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

{
	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
		}
	}
}