Trendsic Platform Service

<back to all web services

FormVersionRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/versions/{VersionNo}
"use strict";
export class FormVersionRow {
    /** @param {{VersionNo?:number,PublishedAt?:string,PublishedBy?:string,Notes?:string,Changes?:string[],IsLive?:boolean,Submissions?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    VersionNo;
    /** @type {?string} */
    PublishedAt;
    /** @type {string} */
    PublishedBy;
    /** @type {string} */
    Notes;
    /** @type {string[]} */
    Changes = [];
    /** @type {boolean} */
    IsLive;
    /** @type {number} */
    Submissions;
}
export class FormVersionDetail extends FormVersionRow {
    /** @param {{DefinitionJson?:string,DefinitionHash?:string,VersionNo?:number,PublishedAt?:string,PublishedBy?:string,Notes?:string,Changes?:string[],IsLive?:boolean,Submissions?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    DefinitionJson;
    /** @type {string} */
    DefinitionHash;
}
export class FormVersionResponse {
    /** @param {{Version?:FormVersionDetail,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormVersionDetail} */
    Version;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormVersionRequest {
    /** @param {{FormUID?:string,VersionNo?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
    /** @type {number} */
    VersionNo;
}

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