tvpl.api

<back to all web services

PendingAccessRequests

Requires Authentication
The following routes are available for this service:
GET/document-permission/Pending-Access-Requests
namespace tvpl.api.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type DocumentAccessPermissions =
        | Read = 0
        | Write = 1
        | GrantRead = 2

    type DocumentApprovalStatus =
        | Pending = 0
        | Approved = 1
        | Rejected = 2

    [<AllowNullLiteral>]
    type DocumentAccessRequest() = 
        member val Id:Int32 = new Int32() with get,set
        member val DocumentId:Int32 = new Int32() with get,set
        member val RequestedBy:Int32 = new Int32() with get,set
        member val RequestPermission:DocumentAccessPermissions = new DocumentAccessPermissions() with get,set
        member val Status:DocumentApprovalStatus = new DocumentApprovalStatus() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ApprovedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ApprovedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Note:String = null with get,set
        member val Comment:String = null with get,set
        member val DueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DocumentAccessRequestView() = 
        inherit DocumentAccessRequest()
        member val ApprovedByName:String = null with get,set
        member val RequestedName:String = null with get,set
        member val DocumentTitle:String = null with get,set

    [<AllowNullLiteral>]
    type PendingAccessResponse() = 
        member val Total:Int32 = new Int32() with get,set
        member val Code:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val Requests:ResizeArray<DocumentAccessRequestView> = new ResizeArray<DocumentAccessRequestView>() with get,set

    [<AllowNullLiteral>]
    type PagingRequest() = 
        member val Page:Int32 = new Int32() with get,set
        member val Limit:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PendingAccessRequests() = 
        inherit PagingRequest()
        member val Status:Nullable<DocumentApprovalStatus> = new Nullable<DocumentApprovalStatus>() with get,set

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