tvpl.api

PendingAccessRequests

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