tvpl.api

<back to all web services

AssignDocumentPermissionsRequest

Requires Authentication
The following routes are available for this service:
POST/document-permission/assign
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 DocumentPemissionResponse:
    code: int = 0
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AssignDocumentPermissionsRequest(IPost):
    document_id: int = 0
    account_ids: Optional[List[int]] = None
    reason: Optional[str] = None
    date_expired: Optional[datetime.datetime] = None
    can_read: bool = False
    can_write: bool = False
    can_comment: bool = False
    can_grant_read: bool = False
    team_id: int = 0

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

POST /document-permission/assign HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AssignDocumentPermissionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </AccountIds>
  <CanComment>false</CanComment>
  <CanGrantRead>false</CanGrantRead>
  <CanRead>false</CanRead>
  <CanWrite>false</CanWrite>
  <DateExpired>0001-01-01T00:00:00</DateExpired>
  <DocumentId>0</DocumentId>
  <Reason>String</Reason>
  <TeamId>0</TeamId>
</AssignDocumentPermissionsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentPemissionResponse 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>
</DocumentPemissionResponse>