Trendsic Platform Service

FormVersionRequest

The following routes are available for this service:
GET	/v1/forms/{FormUID}/versions/{VersionNo}

import Foundation
import ServiceStack

public class FormVersionRequest : Codable
{
    public var formUID:String
    public var versionNo:Int

    required public init(){}
}

public class FormVersionResponse : Codable
{
    public var version:FormVersionDetail
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormVersionDetail : FormVersionRow
{
    public var definitionJson:String
    public var definitionHash:String

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

    private enum CodingKeys : String, CodingKey {
        case definitionJson
        case definitionHash
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        definitionJson = try container.decodeIfPresent(String.self, forKey: .definitionJson)
        definitionHash = try container.decodeIfPresent(String.self, forKey: .definitionHash)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if definitionJson != nil { try container.encode(definitionJson, forKey: .definitionJson) }
        if definitionHash != nil { try container.encode(definitionHash, forKey: .definitionHash) }
    }
}

public class FormVersionRow : Codable
{
    public var versionNo:Int
    public var publishedAt:Date?
    public var publishedBy:String
    public var notes:String
    public var changes:[String] = []
    public var isLive:Bool
    public var submissions:Int

    required public init(){}
}

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

GET /v1/forms/{FormUID}/versions/{VersionNo} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Version: 
	{
		DefinitionJson: String,
		DefinitionHash: String,
		VersionNo: 0,
		PublishedAt: 0001-01-01,
		PublishedBy: String,
		Notes: String,
		Changes: 
		[
			String
		],
		IsLive: False,
		Submissions: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}