tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search
SearchTemplateRequest Parameters:
NameParameterData TypeRequiredDescription
TitlequerystringNo
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
SearchDocumentTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformList<DocumentTemplate>No
TotalCountformlongNo
DocumentTemplate Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringYes
DescriptionformstringNo
IsActiveformboolNo
DocumentIdsformList<int>No
DocumentsformList<Document>No
Document Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ReasonReturnformstringNo
AccountIdformint?No
DeletedAtformDateTime?No
DeletedByformstringNo
UpdatedByformstringNo
CreatedAtformDateTime?No
CreatedByformstringNo
IsPartyformbool?No
IsRevisionRequestedformboolNo
LastUpdatedAtformDateTime?No
IsPrivateformbool?No
DepartmentIdformint?No
PublicationDateformDateTime?No
ProcessStatusIdformint?No
FullTextSearchContentformstringNo
BasicDocument Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
DescriptionformstringYes
OwnerformstringNo
DocumentPolicyIdformint?No
UpdateDocumentIdformint?No
EffectBeginDateformDateTime?No
EffectEndDateformDateTime?No
IssuingAgencyIdformint?No
DocumentTypeIdformint?No
DocumentGroupIdformint?No
SubjectIdformint?No
SignByformstringNo
SignDateformDateTime?No
StatusIdformint?No
IsInternalformboolNo
DocumentNumberformstringNo
DocumentCodeformstringNo
IsUrgentformbool?No
ScopeTypeformint?No
IsActiveformbool?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/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			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
				}
			]
		}
	],
	totalCount: 0
}