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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PendingAccessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Message>String</Message>
  <Requests xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentAccessRequestView>
      <d2p1:ApprovedBy>0</d2p1:ApprovedBy>
      <d2p1:ApprovedDate>0001-01-01T00:00:00</d2p1:ApprovedDate>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:DocumentId>0</d2p1:DocumentId>
      <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:RequestPermission>Read</d2p1:RequestPermission>
      <d2p1:RequestedBy>0</d2p1:RequestedBy>
      <d2p1:Status>Pending</d2p1:Status>
      <d2p1:ApprovedByName>String</d2p1:ApprovedByName>
      <d2p1:DocumentTitle>String</d2p1:DocumentTitle>
      <d2p1:RequestedName>String</d2p1:RequestedName>
    </d2p1:DocumentAccessRequestView>
  </Requests>
  <Total>0</Total>
</PendingAccessResponse>