tvpl.api

<back to all web services

MergeFileRequest

Requires Authentication
The following routes are available for this service:
POST/merge-file
MergeFileRequest Parameters:
NameParameterData TypeRequiredDescription
TemplatebodyTemplateDefinitionDtoYes
ElementsbodyList<ElementDefinitionDto>Yes
TemplateDefinitionDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DocumentIdformintNo
TitleformstringYes
DescriptionformstringYes
IsActiveformboolNo
ElementDefinitionDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TemplateIdformintNo
ElementKeyformstringYes
TagformstringYes
TitleformstringYes
DescriptionformstringYes
DataTypeformstringYes
TemplateTypeformstringYes
OrderIndexformintNo
ParentIdformint?No
ValueformObjectYes
ChildrenformList<ElementDefinitionDto>Yes

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

{}