tvpl.api

ReportSearch

The following routes are available for this service:
POST	/report/search

**ReportSearch** Parameters:
Name	Parameter	Data Type	Required
Columns	body	List<string>	No
Title	body	string	No
TypeId	body	int?	No
GroupId	body	int?	No
SubjectId	body	int?	No
IsUrgent	body	bool?	No
DocumentSearchStage	body	DocumentSearchStage	No
IsInternal	body	bool?	No
FromDate	body	DateTime?	No
ToDate	body	DateTime?	No
StatusId	body	int?	No
IssuingAgencyId	body	int?	No
OrderBy	body	SearchOrderBy	No
IsParty	body	bool?	No

**PagingRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	int	No
Limit	form	int	No

**DocumentSearchStage** Enum:
All
AllProcessing
Draft
PendingApproval
IsRevisionRequested
PendingCompilation
PendingReport
Published
Active
InActive

**SearchOrderBy** Enum:
UpdatedDateDesc
PublishDateDesc

**SearchResponse** Parameters:
Name	Parameter	Data Type	Required
TotalCount	form	long	No
Code	form	int	No
Data	form	List<DocumentSearchResultItem>	Yes
Message	form	string	Yes

**DocumentSearchResultItem** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
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
SubjectId	form	int?	No
SignBy	form	string	No
SignDate	form	DateTime?	No
UpdatedAt	form	DateTime?	No
StatusId	form	int?	No
IsInternal	form	bool	No
DocumentNumber	form	string	No
DocumentCode	form	string	No
IsUrgent	form	bool?	No
Id	form	int	No
ReasonReturn	form	string	No
AccountId	form	int?	No
ApproverId	form	int?	No
UpdatedBy	form	string	No
CreatedBy	form	string	No
IsParty	form	bool?	No
IsRevisionRequested	form	bool?	No
IsPrivate	form	bool?	No
DepartmentId	form	int?	No
PublicationDate	form	DateTime?	No
ProcessStatusId	form	int	No
DocumentTypeId	form	int?	No
DocumentGroupId	form	int?	No
AccountName	form	string	No
AcceptAccountName	form	string	No
DocumentGroupText	form	string	No
ProcessStatusText	form	string	No
DocumentTypeText	form	string	No
DepartmentText	form	string	No
StatusText	form	string	No
IssuingAgencyText	form	string	No
SubjectText	form	string	No
Comment	form	string	No
SubmitComment	form	string	No
FullFile	form	string	No
ParthFile	form	string	No
IsActive	form	bool?	No
StepOrder	form	int?	No
StepCount	form	int?	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.

POST /report/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	columns: 
	[
		String
	],
	title: String,
	typeId: 0,
	groupId: 0,
	subjectId: 0,
	isUrgent: False,
	documentSearchStage: All,
	isInternal: False,
	fromDate: "0001-01-01T00:00:00.0000000+07:06",
	toDate: "0001-01-01T00:00:00.0000000+07:06",
	statusId: 0,
	issuingAgencyId: 0,
	orderBy: UpdatedDateDesc,
	isParty: False,
	page: 1,
	limit: 10
}

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

{
	totalCount: 0,
	code: 0,
	data: 
	[
		{
			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,
			subjectId: 0,
			signBy: String,
			signDate: "0001-01-01T00:00:00.0000000+07:06",
			updatedAt: "0001-01-01T00:00:00.0000000+07:06",
			statusId: 0,
			isInternal: False,
			documentNumber: String,
			documentCode: String,
			isUrgent: False,
			id: 0,
			reasonReturn: String,
			accountId: 0,
			approverId: 0,
			updatedBy: String,
			createdBy: String,
			isParty: False,
			isRevisionRequested: False,
			isPrivate: False,
			departmentId: 0,
			publicationDate: "0001-01-01T00:00:00.0000000+07:06",
			processStatusId: 0,
			documentTypeId: 0,
			documentGroupId: 0,
			accountName: String,
			acceptAccountName: String,
			documentGroupText: String,
			processStatusText: String,
			documentTypeText: String,
			departmentText: String,
			statusText: String,
			issuingAgencyText: String,
			subjectText: String,
			comment: String,
			submitComment: String,
			fullFile: String,
			parthFile: String,
			isActive: False,
			stepOrder: 0,
			stepCount: 0
		}
	],
	message: String
}