tvpl.api

<back to all web services

GetTemplateByIdRequest

Requires Authentication
The following routes are available for this service:
GET/document-template
GetTemplateByIdRequest Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
DocumentTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
TemplateformDocumentTemplateDtoNo
InsertedIdformintNo
CodeformintNo
MessageformstringNo
DocumentTemplateDto Parameters:
NameParameterData TypeRequiredDescription
ElementsformList<DocumentElementDto>No
DocumentTemplate Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringYes
DescriptionformstringNo
IsActiveformboolNo
FileKeyformstringNo
FileUrlformstringNo
FileNameformstringNo
FileSizeformlong?No
DocumentElementDto Parameters:
NameParameterData TypeRequiredDescription
ChildrenformList<DocumentElementDto>Yes
DocumentElement Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TemplateIdformintNo
ElementKeyformstringYes
TagformstringYes
ParentIdformint?No
TitleformstringYes
DescriptionformstringNo
DataTypeformstringYes
TemplateTypeformstringNo
OrderIndexformintNo
IsRequiredformbool?No

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

HTTP + OTHER

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

GET /document-template HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"template":{"elements":[{"children":[{"children":[{"children":null,"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"title":"String","description":"String","isActive":false,"fileKey":"String","fileUrl":"String","fileName":"String","fileSize":0},"insertedId":0,"code":0,"message":"String"}