tvpl.api

<back to all web services

SearchDocumentPolicyRequest

Requires Authentication
The following routes are available for this service:
GET/DocumentPolicy
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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentPolicyFilter(PagingRequest):
    department_id: Optional[int] = None
    name: Optional[str] = None
    is_approved: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDocumentPolicyModel:
    id: int = 0
    policy_code: Optional[str] = None
    title: Optional[str] = None
    document_link: Optional[str] = None
    document_group_id: int = 0
    description: Optional[str] = None
    approved_by: Optional[int] = None
    # @Required()
    department_lead_id: int = 0

    department_co_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentPolicy(UpdateDocumentPolicyModel):
    approved_date: Optional[datetime.datetime] = None
    estimated_deadline: Optional[datetime.datetime] = None
    is_approved: bool = False
    # @Required()
    created_by: int = 0

    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    deleted_at: Optional[datetime.datetime] = None
    deleted_by: Optional[int] = None
    approval_comment: Optional[str] = None
    is_deleted: Optional[bool] = None
    last_update_at: Optional[datetime.datetime] = None
    updated_by: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentPolicyResponse(IResponseRequest):
    code: int = 0
    message: Optional[str] = None
    document_policy: Optional[List[DocumentPolicy]] = None
    unapproved_count: int = 0
    total_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchDocumentPolicyRequest(DocumentPolicyFilter, IGet):
    pass

Python SearchDocumentPolicyRequest 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 /DocumentPolicy HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentPolicyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <DocumentPolicy xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentPolicy>
      <d2p1:ApprovedBy>0</d2p1:ApprovedBy>
      <d2p1:DepartmentCoId>0</d2p1:DepartmentCoId>
      <d2p1:DepartmentLeadId>0</d2p1:DepartmentLeadId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
      <d2p1:DocumentLink>String</d2p1:DocumentLink>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PolicyCode>String</d2p1:PolicyCode>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:ApprovalComment>String</d2p1:ApprovalComment>
      <d2p1:ApprovedDate>0001-01-01T00:00:00</d2p1:ApprovedDate>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:EstimatedDeadline>0001-01-01T00:00:00</d2p1:EstimatedDeadline>
      <d2p1:IsApproved>false</d2p1:IsApproved>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:LastUpdateAt>0001-01-01T00:00:00</d2p1:LastUpdateAt>
      <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
    </d2p1:DocumentPolicy>
  </DocumentPolicy>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
  <UnapprovedCount>0</UnapprovedCount>
</DocumentPolicyResponse>