tvpl.api

GetTemplateByIdRequest

The following routes are available for this service:
GET	/document-template

**GetTemplateByIdRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	int	No

**DocumentTemplateResponse** Parameters:
Name	Parameter	Data Type	Required
Template	form	DocumentTemplateDto	No
InsertedId	form	int	No
Code	form	int	No
Message	form	string	No

**DocumentTemplateDto** Parameters:
Name	Parameter	Data Type	Required	Description
Elements	form	List<DocumentElementDto>	No

**DocumentTemplate** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Title	form	string	Yes
Description	form	string	No
IsActive	form	bool	No
FileKey	form	string	No
FileUrl	form	string	No
FileName	form	string	No
FileSize	form	long?	No

**DocumentElementDto** Parameters:
Name	Parameter	Data Type	Required	Description
Children	form	List<DocumentElementDto>	Yes

**DocumentElement** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TemplateId	form	int	No
ElementKey	form	string	Yes
Tag	form	string	Yes
ParentId	form	int?	No
Title	form	string	Yes
Description	form	string	No
DataType	form	string	Yes
TemplateType	form	string	No
OrderIndex	form	int	No
IsRequired	form	bool?	No

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	template: 
	{
		elements: 
		[
			{
				children: 
				[
					{
						children: 
						[
							{
								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
}