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}

export class FormVersionRow
{
    public VersionNo: number;
    public PublishedAt?: string;
    public PublishedBy: string;
    public Notes: string;
    public Changes: string[] = [];
    public IsLive: boolean;
    public Submissions: number;

    public constructor(init?: Partial<FormVersionRow>) { (Object as any).assign(this, init); }
}

export class FormVersionDetail extends FormVersionRow
{
    public DefinitionJson: string;
    public DefinitionHash: string;

    public constructor(init?: Partial<FormVersionDetail>) { super(init); (Object as any).assign(this, init); }
}

export class FormVersionResponse
{
    public Version: FormVersionDetail;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormVersionResponse>) { (Object as any).assign(this, init); }
}

export class FormVersionRequest
{
    public FormUID: string;
    public VersionNo: number;

    public constructor(init?: Partial<FormVersionRequest>) { (Object as any).assign(this, init); }
}

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