tvpl.api

<back to all web services

StatDocByGroupRequest

Requires Authentication
The following routes are available for this service:
POST/document/stat-search-by-group
SimpleSearchFilter Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
GroupIdformint?No
SubjectIdformint?No
IsUrgentformbool?No
DocumentSearchStageformDocumentSearchStageNo
IsInternalformbool?No
FromDateformDateTime?No
ToDateformDateTime?No
TypeIdformint?No
StatusIdformint?No
IssuingAgencyIdformint?No
IsPartyformbool?No
DocumentSearchStage Enum:
All
AllProcessing
Draft
PendingApproval
IsRevisionRequested
PendingCompilation
PendingReport
Published
Active
InActive
SearchResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformlongNo
CodeformintNo
DataformList<DocumentSearchResultItem>Yes
MessageformstringYes
DocumentSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
DescriptionformstringYes
OwnerformstringNo
DocumentPolicyIdformint?No
UpdateDocumentIdformint?No
EffectBeginDateformDateTime?No
EffectEndDateformDateTime?No
IssuingAgencyIdformint?No
SubjectIdformint?No
SignByformstringNo
SignDateformDateTime?No
UpdatedAtformDateTime?No
StatusIdformint?No
IsInternalformboolNo
DocumentNumberformstringNo
DocumentCodeformstringNo
IsUrgentformbool?No
IdformintNo
ReasonReturnformstringNo
AccountIdformint?No
ApproverIdformint?No
UpdatedByformstringNo
CreatedByformstringNo
IsPartyformbool?No
IsRevisionRequestedformbool?No
IsPrivateformbool?No
DepartmentIdformint?No
PublicationDateformDateTime?No
ProcessStatusIdformintNo
DocumentTypeIdformint?No
DocumentGroupIdformint?No
AccountNameformstringNo
AcceptAccountNameformstringNo
DocumentGroupTextformstringNo
ProcessStatusTextformstringNo
DocumentTypeTextformstringNo
DepartmentTextformstringNo
StatusTextformstringNo
IssuingAgencyTextformstringNo
SubjectTextformstringNo
CommentformstringNo
SubmitCommentformstringNo
FullFileformstringNo
ParthFileformstringNo
IsActiveformbool?No
StepOrderformint?No
StepCountformint?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 /document/stat-search-by-group HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	title: String,
	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",
	typeId: 0,
	statusId: 0,
	issuingAgencyId: 0,
	isParty: False
}
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
}