tvpl.api

PendingAccessRequests

The following routes are available for this service:
GET	/document-permission/Pending-Access-Requests

import Foundation
import ServiceStack

public class PendingAccessRequests : PagingRequest
{
    public var status:DocumentApprovalStatus?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case status
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        status = try container.decodeIfPresent(DocumentApprovalStatus.self, forKey: .status)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if status != nil { try container.encode(status, forKey: .status) }
    }
}

public class PagingRequest : Codable
{
    public var page:Int
    public var limit:Int

    required public init(){}
}

public enum DocumentApprovalStatus : String, Codable
{
    case Pending
    case Approved
    case Rejected
}

public class PendingAccessResponse : Codable
{
    public var total:Int
    public var code:Int
    public var message:String
    public var requests:[DocumentAccessRequestView] = []

    required public init(){}
}

public class DocumentAccessRequestView : DocumentAccessRequest
{
    public var approvedByName:String
    public var requestedName:String
    public var documentTitle:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case approvedByName
        case requestedName
        case documentTitle
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        approvedByName = try container.decodeIfPresent(String.self, forKey: .approvedByName)
        requestedName = try container.decodeIfPresent(String.self, forKey: .requestedName)
        documentTitle = try container.decodeIfPresent(String.self, forKey: .documentTitle)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if approvedByName != nil { try container.encode(approvedByName, forKey: .approvedByName) }
        if requestedName != nil { try container.encode(requestedName, forKey: .requestedName) }
        if documentTitle != nil { try container.encode(documentTitle, forKey: .documentTitle) }
    }
}

public class DocumentAccessRequest : Codable
{
    public var id:Int
    public var documentId:Int
    public var requestedBy:Int
    public var requestPermission:DocumentAccessPermissions
    public var status:DocumentApprovalStatus
    public var createdDate:Date
    public var approvedBy:Int?
    public var approvedDate:Date?
    public var note:String
    public var comment:String
    public var dueDate:Date?

    required public init(){}
}

public enum DocumentAccessPermissions : String, Codable
{
    case Read
    case Write
    case GrantRead
}

Swift 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"}]}