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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormVersionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Version>
    <Changes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Changes>
    <IsLive>false</IsLive>
    <Notes>String</Notes>
    <PublishedAt>0001-01-01T00:00:00</PublishedAt>
    <PublishedBy>String</PublishedBy>
    <Submissions>0</Submissions>
    <VersionNo>0</VersionNo>
    <DefinitionHash>String</DefinitionHash>
    <DefinitionJson>String</DefinitionJson>
  </Version>
</FormVersionResponse>