Trendsic Platform Service

<back to all web services

FormRestoreRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/restore
import Foundation
import ServiceStack

public class FormRestoreRequest : 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 FormRestoreRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/forms/{FormUID}/restore HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FormUID":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Form":{"DraftJson":"String","DraftRev":0,"SourceTemplateUID":"00000000000000000000000000000000","Warnings":["String"],"AlwaysHidden":["String"],"FormUID":"00000000000000000000000000000000","Name":"String","Slug":"String","Noun":"String","NumberPrefix":"String","Description":"String","Tone":"String","Status":"String","PublishedVersionNo":0,"PublishedAt":"0001-01-01T00:00:00.0000000","PublishedBy":"String","DraftDirty":false,"DraftUpdatedAt":"0001-01-01T00:00:00.0000000","DraftUpdatedBy":"String","PackLabel":"String","SettingsJson":"String","Stats":{"Total":0,"NeedDecision":0,"Waiting":0,"Overdue":0},"Offered":["String"],"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}