tvpl.api

<back to all web services

PendingAccessRequests

Requires Authentication
The following routes are available for this service:
GET/document-permission/Pending-Access-Requests
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class PendingAccessRequests extends PagingRequest
    {
        public DocumentApprovalStatus status = null;
        
        public DocumentApprovalStatus getStatus() { return status; }
        public PendingAccessRequests setStatus(DocumentApprovalStatus value) { this.status = value; return this; }
    }

    public static class PagingRequest
    {
        public Integer page = null;
        public Integer limit = null;
        
        public Integer getPage() { return page; }
        public PagingRequest setPage(Integer value) { this.page = value; return this; }
        public Integer getLimit() { return limit; }
        public PagingRequest setLimit(Integer value) { this.limit = value; return this; }
    }

    public static enum DocumentApprovalStatus
    {
        Pending,
        Approved,
        Rejected;
    }

    public static class PendingAccessResponse
    {
        public Integer total = null;
        public Integer code = null;
        public String message = null;
        public ArrayList<DocumentAccessRequestView> requests = null;
        
        public Integer getTotal() { return total; }
        public PendingAccessResponse setTotal(Integer value) { this.total = value; return this; }
        public Integer getCode() { return code; }
        public PendingAccessResponse setCode(Integer value) { this.code = value; return this; }
        public String getMessage() { return message; }
        public PendingAccessResponse setMessage(String value) { this.message = value; return this; }
        public ArrayList<DocumentAccessRequestView> getRequests() { return requests; }
        public PendingAccessResponse setRequests(ArrayList<DocumentAccessRequestView> value) { this.requests = value; return this; }
    }

    public static class DocumentAccessRequestView extends DocumentAccessRequest
    {
        public String approvedByName = null;
        public String requestedName = null;
        public String documentTitle = null;
        
        public String getApprovedByName() { return approvedByName; }
        public DocumentAccessRequestView setApprovedByName(String value) { this.approvedByName = value; return this; }
        public String getRequestedName() { return requestedName; }
        public DocumentAccessRequestView setRequestedName(String value) { this.requestedName = value; return this; }
        public String getDocumentTitle() { return documentTitle; }
        public DocumentAccessRequestView setDocumentTitle(String value) { this.documentTitle = value; return this; }
    }

    public static class DocumentAccessRequest
    {
        public Integer id = null;
        public Integer documentId = null;
        public Integer requestedBy = null;
        public DocumentAccessPermissions requestPermission = null;
        public DocumentApprovalStatus status = null;
        public Date createdDate = null;
        public Integer approvedBy = null;
        public Date approvedDate = null;
        public String note = null;
        public String comment = null;
        public Date dueDate = null;
        
        public Integer getId() { return id; }
        public DocumentAccessRequest setId(Integer value) { this.id = value; return this; }
        public Integer getDocumentId() { return documentId; }
        public DocumentAccessRequest setDocumentId(Integer value) { this.documentId = value; return this; }
        public Integer getRequestedBy() { return requestedBy; }
        public DocumentAccessRequest setRequestedBy(Integer value) { this.requestedBy = value; return this; }
        public DocumentAccessPermissions getRequestPermission() { return requestPermission; }
        public DocumentAccessRequest setRequestPermission(DocumentAccessPermissions value) { this.requestPermission = value; return this; }
        public DocumentApprovalStatus getStatus() { return status; }
        public DocumentAccessRequest setStatus(DocumentApprovalStatus value) { this.status = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public DocumentAccessRequest setCreatedDate(Date value) { this.createdDate = value; return this; }
        public Integer getApprovedBy() { return approvedBy; }
        public DocumentAccessRequest setApprovedBy(Integer value) { this.approvedBy = value; return this; }
        public Date getApprovedDate() { return approvedDate; }
        public DocumentAccessRequest setApprovedDate(Date value) { this.approvedDate = value; return this; }
        public String getNote() { return note; }
        public DocumentAccessRequest setNote(String value) { this.note = value; return this; }
        public String getComment() { return comment; }
        public DocumentAccessRequest setComment(String value) { this.comment = value; return this; }
        public Date getDueDate() { return dueDate; }
        public DocumentAccessRequest setDueDate(Date value) { this.dueDate = value; return this; }
    }

    public static enum DocumentAccessPermissions
    {
        Read,
        Write,
        GrantRead;
    }

}

Java PendingAccessRequests DTOs

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>