tvpl.api

<back to all web services

MergeFileRequest

Requires Authentication
The following routes are available for this service:
POST/merge-file
import Foundation
import ServiceStack

public class MergeFileRequest : Codable
{
    public var template:TemplateDefinitionDto
    public var elements:[ElementDefinitionDto] = []

    required public init(){}
}

public class TemplateDefinitionDto : Codable
{
    public var id:Int
    public var documentId:Int
    public var title:String
    public var Description:String
    public var isActive:Bool

    required public init(){}
}

public class ElementDefinitionDto : Codable
{
    public var id:Int
    public var templateId:Int
    public var elementKey:String
    public var tag:String
    public var title:String
    public var Description:String
    public var dataType:String
    public var templateType:String
    public var orderIndex:Int
    public var parentId:Int?
    //value:Object ignored. Type could not be extended in Swift
    public var children:[ElementDefinitionDto] = []

    required public init(){}
}

Swift MergeFileRequest 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 /merge-file HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"template":{"id":0,"documentId":0,"title":"String","description":"String","isActive":false},"elements":[{"id":0,"templateId":0,"elementKey":"String","tag":"String","title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"parentId":0,"value":{},"children":[{"id":0,"templateId":0,"elementKey":"String","tag":"String","title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"parentId":0,"value":{},"children":[{"id":0,"templateId":0,"elementKey":"String","tag":"String","title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"parentId":0,"value":{},"children":null}]}]}]}

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

{}