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.*


open class PendingAccessRequests : PagingRequest()
{
    var status:DocumentApprovalStatus? = null
}

open class PagingRequest
{
    var page:Int? = null
    var limit:Int? = null
}

enum class DocumentApprovalStatus
{
    Pending,
    Approved,
    Rejected,
}

open class PendingAccessResponse
{
    var total:Int? = null
    var code:Int? = null
    var message:String? = null
    var requests:ArrayList<DocumentAccessRequestView> = ArrayList<DocumentAccessRequestView>()
}

open class DocumentAccessRequestView : DocumentAccessRequest()
{
    var approvedByName:String? = null
    var requestedName:String? = null
    var documentTitle:String? = null
}

open class DocumentAccessRequest
{
    var id:Int? = null
    var documentId:Int? = null
    var requestedBy:Int? = null
    var requestPermission:DocumentAccessPermissions? = null
    var status:DocumentApprovalStatus? = null
    var createdDate:Date? = null
    var approvedBy:Int? = null
    var approvedDate:Date? = null
    var note:String? = null
    var comment:String? = null
    var dueDate:Date? = null
}

enum class DocumentAccessPermissions
{
    Read,
    Write,
    GrantRead,
}

Kotlin PendingAccessRequests DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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","createdDate":"0001-01-01T00:00:00.0000000+07:06","approvedBy":0,"approvedDate":"0001-01-01T00:00:00.0000000+07:06","note":"String","comment":"String","dueDate":"0001-01-01T00:00:00.0000000+07:06"}]}