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