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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormVersionRow() = 
        member val VersionNo:Int32 = new Int32() with get,set
        member val PublishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PublishedBy:String = null with get,set
        member val Notes:String = null with get,set
        member val Changes:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val IsLive:Boolean = new Boolean() with get,set
        member val Submissions:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FormVersionDetail() = 
        inherit FormVersionRow()
        member val DefinitionJson:String = null with get,set
        member val DefinitionHash:String = null with get,set

    [<AllowNullLiteral>]
    type FormVersionResponse() = 
        member val Version:FormVersionDetail = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormVersionRequest() = 
        member val FormUID:Guid = new Guid() with get,set
        member val VersionNo:Int32 = new Int32() with get,set

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