Trendsic Platform Service

<back to all web services

FormDetailRequest

import Foundation
import ServiceStack

public class FormDetailRequest : Codable
{
    public var formUID:String

    required public init(){}
}

public class FormResponse : Codable
{
    public var form:FormDetail
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormDetail : FormCard
{
    public var draftJson:String
    public var draftRev:Int
    public var sourceTemplateUID:String?
    public var warnings:[String] = []
    public var alwaysHidden:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case draftJson
        case draftRev
        case sourceTemplateUID
        case warnings
        case alwaysHidden
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        draftJson = try container.decodeIfPresent(String.self, forKey: .draftJson)
        draftRev = try container.decodeIfPresent(Int.self, forKey: .draftRev)
        sourceTemplateUID = try container.decodeIfPresent(String.self, forKey: .sourceTemplateUID)
        warnings = try container.decodeIfPresent([String].self, forKey: .warnings) ?? []
        alwaysHidden = try container.decodeIfPresent([String].self, forKey: .alwaysHidden) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if draftJson != nil { try container.encode(draftJson, forKey: .draftJson) }
        if draftRev != nil { try container.encode(draftRev, forKey: .draftRev) }
        if sourceTemplateUID != nil { try container.encode(sourceTemplateUID, forKey: .sourceTemplateUID) }
        if warnings.count > 0 { try container.encode(warnings, forKey: .warnings) }
        if alwaysHidden.count > 0 { try container.encode(alwaysHidden, forKey: .alwaysHidden) }
    }
}

public class FormCard : Codable
{
    public var formUID:String
    public var name:String
    public var slug:String
    public var noun:String
    public var numberPrefix:String
    public var Description:String
    public var tone:String
    public var status:String
    public var publishedVersionNo:Int?
    public var publishedAt:Date?
    public var publishedBy:String
    public var draftDirty:Bool
    public var draftUpdatedAt:Date?
    public var draftUpdatedBy:String
    public var packLabel:String
    public var settingsJson:String
    public var stats:FormStats
    public var offered:[String] = []
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}

public class FormStats : Codable
{
    public var total:Int
    public var needDecision:Int
    public var waiting:Int
    public var overdue:Int

    required public init(){}
}

Swift FormDetailRequest DTOs

GET /v1/forms/{FormUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Form>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <Description>String</Description>
    <DraftDirty>false</DraftDirty>
    <DraftUpdatedAt>0001-01-01T00:00:00</DraftUpdatedAt>
    <DraftUpdatedBy>String</DraftUpdatedBy>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Name>String</Name>
    <Noun>String</Noun>
    <NumberPrefix>String</NumberPrefix>
    <Offered xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Offered>
    <PackLabel>String</PackLabel>
    <PublishedAt>0001-01-01T00:00:00</PublishedAt>
    <PublishedBy>String</PublishedBy>
    <PublishedVersionNo>0</PublishedVersionNo>
    <SettingsJson>String</SettingsJson>
    <Slug>String</Slug>
    <Stats>
      <NeedDecision>0</NeedDecision>
      <Overdue>0</Overdue>
      <Total>0</Total>
      <Waiting>0</Waiting>
    </Stats>
    <Status>String</Status>
    <Tone>String</Tone>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <AlwaysHidden xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </AlwaysHidden>
    <DraftJson>String</DraftJson>
    <DraftRev>0</DraftRev>
    <SourceTemplateUID>00000000-0000-0000-0000-000000000000</SourceTemplateUID>
    <Warnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Warnings>
  </Form>
  <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>
</FormResponse>