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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagingRequest:
    page: int = 0
    limit: int = 0


class DocumentAccessPermissions(str, Enum):
    READ = 'Read'
    WRITE = 'Write'
    GRANT_READ = 'GrantRead'


class DocumentApprovalStatus(str, Enum):
    PENDING = 'Pending'
    APPROVED = 'Approved'
    REJECTED = 'Rejected'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentAccessRequest:
    id: int = 0
    document_id: int = 0
    requested_by: int = 0
    request_permission: Optional[DocumentAccessPermissions] = None
    status: Optional[DocumentApprovalStatus] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    approved_by: Optional[int] = None
    approved_date: Optional[datetime.datetime] = None
    note: Optional[str] = None
    comment: Optional[str] = None
    due_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentAccessRequestView(DocumentAccessRequest):
    approved_by_name: Optional[str] = None
    requested_name: Optional[str] = None
    document_title: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PendingAccessResponse:
    total: int = 0
    code: int = 0
    message: Optional[str] = None
    requests: Optional[List[DocumentAccessRequestView]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PendingAccessRequests(PagingRequest):
    status: Optional[DocumentApprovalStatus] = None

Python PendingAccessRequests DTOs

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

HTTP + JSV

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