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
DocumentIds	form	List<int>	No
Documents	form	List<Document>	No

**Document** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ReasonReturn	form	string	No
AccountId	form	int?	No
DeletedAt	form	DateTime?	No
DeletedBy	form	string	No
UpdatedBy	form	string	No
CreatedAt	form	DateTime?	No
CreatedBy	form	string	No
IsParty	form	bool?	No
IsRevisionRequested	form	bool	No
LastUpdatedAt	form	DateTime?	No
IsPrivate	form	bool?	No
DepartmentId	form	int?	No
PublicationDate	form	DateTime?	No
ProcessStatusId	form	int?	No
FullTextSearchContent	form	string	No

**BasicDocument** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	Yes
Description	form	string	Yes
Owner	form	string	No
DocumentPolicyId	form	int?	No
UpdateDocumentId	form	int?	No
EffectBeginDate	form	DateTime?	No
EffectEndDate	form	DateTime?	No
IssuingAgencyId	form	int?	No
DocumentTypeId	form	int?	No
DocumentGroupId	form	int?	No
SubjectId	form	int?	No
SignBy	form	string	No
SignDate	form	DateTime?	No
StatusId	form	int?	No
IsInternal	form	bool	No
DocumentNumber	form	string	No
DocumentCode	form	string	No
IsUrgent	form	bool?	No
ScopeType	form	int?	No
IsActive	form	bool?	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: etc-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,
		documentIds: 
		[
			0
		],
		documents: 
		[
			{
				id: 0,
				reasonReturn: String,
				accountId: 0,
				deletedAt: "0001-01-01T00:00:00.0000000+07:06",
				deletedBy: String,
				updatedBy: String,
				createdAt: "0001-01-01T00:00:00.0000000+07:06",
				createdBy: String,
				isParty: False,
				isRevisionRequested: False,
				lastUpdatedAt: "0001-01-01T00:00:00.0000000+07:06",
				isPrivate: False,
				departmentId: 0,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06",
				processStatusId: 0,
				fullTextSearchContent: String,
				title: String,
				description: String,
				owner: String,
				documentPolicyId: 0,
				updateDocumentId: 0,
				effectBeginDate: "0001-01-01T00:00:00.0000000+07:06",
				effectEndDate: "0001-01-01T00:00:00.0000000+07:06",
				issuingAgencyId: 0,
				documentTypeId: 0,
				documentGroupId: 0,
				subjectId: 0,
				signBy: String,
				signDate: "0001-01-01T00:00:00.0000000+07:06",
				statusId: 0,
				isInternal: False,
				documentNumber: String,
				documentCode: String,
				isUrgent: False,
				scopeType: 0,
				isActive: False
			}
		]
	},
	insertedId: 0,
	code: 0,
	message: String
}