tvpl.api

<back to all web services

PendingAccessRequests

Requires Authentication
The following routes are available for this service:
GET/document-permission/Pending-Access-Requests
PendingAccessRequests Parameters:
NameParameterData TypeRequiredDescription
StatusqueryDocumentApprovalStatus?No
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
DocumentApprovalStatus Enum:
Pending
Approved
Rejected
PendingAccessResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
CodeformintNo
MessageformstringYes
RequestsformList<DocumentAccessRequestView>Yes
DocumentAccessRequestView Parameters:
NameParameterData TypeRequiredDescription
ApprovedByNameformstringNo
RequestedNameformstringNo
DocumentTitleformstringYes
DocumentAccessRequest Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DocumentIdformintNo
RequestedByformintNo
RequestPermissionformDocumentAccessPermissionsNo
StatusformDocumentApprovalStatusNo
CreatedDateformDateTimeNo
ApprovedByformint?No
ApprovedDateformDateTime?No
NoteformstringNo
CommentformstringNo
DueDateformDateTime?No
DocumentAccessPermissions Enum:
Read
Write
GrantRead

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-permission/Pending-Access-Requests HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	total: 0,
	code: 0,
	message: String,
	requests: 
	[
		{
			approvedByName: String,
			requestedName: String,
			documentTitle: String,
			id: 0,
			documentId: 0,
			requestedBy: 0,
			requestPermission: Read,
			status: Pending,
			approvedBy: 0,
			approvedDate: "0001-01-01T00:00:00.0000000+07:06",
			note: String,
			comment: String,
			dueDate: "0001-01-01T00:00:00.0000000+07:06"
		}
	]
}