tvpl.api

<back to all web services

PendingAccessRequests

Requires Authentication
The following routes are available for this service:
GET/document-permission/Pending-Access-Requests
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using tvpl.api.ServiceModel;
using tvpl.data.Constant;
using tvpl.data.Models;

namespace tvpl.api.ServiceModel
{
    public partial class PagingRequest
    {
        public virtual int Page { get; set; }
        public virtual int Limit { get; set; }
    }

    public partial class PendingAccessRequests
        : PagingRequest
    {
        public virtual DocumentApprovalStatus? Status { get; set; }
    }

    public partial class PendingAccessResponse
    {
        public PendingAccessResponse()
        {
            Requests = new List<DocumentAccessRequestView>{};
        }

        public virtual int Total { get; set; }
        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
        public virtual List<DocumentAccessRequestView> Requests { get; set; }
    }

}

namespace tvpl.data.Constant
{
    public enum DocumentAccessPermissions
    {
        Read,
        Write,
        GrantRead,
    }

    public enum DocumentApprovalStatus
    {
        Pending,
        Approved,
        Rejected,
    }

}

namespace tvpl.data.Models
{
    public partial class DocumentAccessRequest
    {
        public virtual int Id { get; set; }
        public virtual int DocumentId { get; set; }
        public virtual int RequestedBy { get; set; }
        public virtual DocumentAccessPermissions RequestPermission { get; set; }
        public virtual DocumentApprovalStatus Status { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual int? ApprovedBy { get; set; }
        public virtual DateTime? ApprovedDate { get; set; }
        public virtual string Note { get; set; }
        public virtual string Comment { get; set; }
        public virtual DateTime? DueDate { get; set; }
    }

    public partial class DocumentAccessRequestView
        : DocumentAccessRequest
    {
        public virtual string ApprovedByName { get; set; }
        public virtual string RequestedName { get; set; }
        public virtual string DocumentTitle { get; set; }
    }

}

C# 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>