tvpl.api

<back to all web services

StatDocByTypeRequest

Requires Authentication
The following routes are available for this service:
POST/document/stat-search-by-type
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


class DocumentSearchStage(str, Enum):
    ALL = 'All'
    ALL_PROCESSING = 'AllProcessing'
    DRAFT = 'Draft'
    PENDING_APPROVAL = 'PendingApproval'
    IS_REVISION_REQUESTED = 'IsRevisionRequested'
    PENDING_COMPILATION = 'PendingCompilation'
    PENDING_REPORT = 'PendingReport'
    PUBLISHED = 'Published'
    ACTIVE = 'Active'
    IN_ACTIVE = 'InActive'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SimpleSearchFilter:
    title: Optional[str] = None
    group_id: Optional[int] = None
    subject_id: Optional[int] = None
    is_urgent: Optional[bool] = None
    document_search_stage: Optional[DocumentSearchStage] = None
    is_internal: Optional[bool] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    type_id: Optional[int] = None
    status_id: Optional[int] = None
    issuing_agency_id: Optional[int] = None
    is_party: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentSearchResultItem:
    title: Optional[str] = None
    description: Optional[str] = None
    owner: Optional[str] = None
    document_policy_id: Optional[int] = None
    update_document_id: Optional[int] = None
    effect_begin_date: Optional[datetime.datetime] = None
    effect_end_date: Optional[datetime.datetime] = None
    issuing_agency_id: Optional[int] = None
    subject_id: Optional[int] = None
    sign_by: Optional[str] = None
    sign_date: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None
    status_id: Optional[int] = None
    is_internal: bool = False
    document_number: Optional[str] = None
    document_code: Optional[str] = None
    is_urgent: Optional[bool] = None
    id: int = 0
    reason_return: Optional[str] = None
    account_id: Optional[int] = None
    approver_id: Optional[int] = None
    # @StringLength(500)
    updated_by: Optional[str] = None

    # @StringLength(500)
    created_by: Optional[str] = None

    is_party: Optional[bool] = None
    is_revision_requested: Optional[bool] = None
    is_private: Optional[bool] = None
    department_id: Optional[int] = None
    publication_date: Optional[datetime.datetime] = None
    process_status_id: int = 0
    document_type_id: Optional[int] = None
    document_group_id: Optional[int] = None
    account_name: Optional[str] = None
    accept_account_name: Optional[str] = None
    document_group_text: Optional[str] = None
    process_status_text: Optional[str] = None
    document_type_text: Optional[str] = None
    department_text: Optional[str] = None
    status_text: Optional[str] = None
    issuing_agency_text: Optional[str] = None
    subject_text: Optional[str] = None
    comment: Optional[str] = None
    submit_comment: Optional[str] = None
    full_file: Optional[str] = None
    parth_file: Optional[str] = None
    is_active: Optional[bool] = None
    step_order: Optional[int] = None
    step_count: Optional[int] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatDocByTypeRequest(SimpleSearchFilter, IPost):
    pass

Python StatDocByTypeRequest 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/stat-search-by-type HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StatDocByTypeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <DocumentSearchStage>All</DocumentSearchStage>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <GroupId>0</GroupId>
  <IsInternal>false</IsInternal>
  <IsParty>false</IsParty>
  <IsUrgent>false</IsUrgent>
  <IssuingAgencyId>0</IssuingAgencyId>
  <StatusId>0</StatusId>
  <SubjectId>0</SubjectId>
  <Title>String</Title>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <TypeId>0</TypeId>
</StatDocByTypeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentSearchResultItem>
      <d2p1:AcceptAccountName>String</d2p1:AcceptAccountName>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:ApproverId>0</d2p1:ApproverId>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DepartmentId>0</d2p1:DepartmentId>
      <d2p1:DepartmentText>String</d2p1:DepartmentText>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DocumentCode>String</d2p1:DocumentCode>
      <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
      <d2p1:DocumentGroupText>String</d2p1:DocumentGroupText>
      <d2p1:DocumentNumber>String</d2p1:DocumentNumber>
      <d2p1:DocumentPolicyId>0</d2p1:DocumentPolicyId>
      <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
      <d2p1:DocumentTypeText>String</d2p1:DocumentTypeText>
      <d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
      <d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
      <d2p1:FullFile>String</d2p1:FullFile>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsInternal>false</d2p1:IsInternal>
      <d2p1:IsParty>false</d2p1:IsParty>
      <d2p1:IsPrivate>false</d2p1:IsPrivate>
      <d2p1:IsRevisionRequested>false</d2p1:IsRevisionRequested>
      <d2p1:IsUrgent>false</d2p1:IsUrgent>
      <d2p1:IssuingAgencyId>0</d2p1:IssuingAgencyId>
      <d2p1:IssuingAgencyText>String</d2p1:IssuingAgencyText>
      <d2p1:Owner>String</d2p1:Owner>
      <d2p1:ParthFile>String</d2p1:ParthFile>
      <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
      <d2p1:ProcessStatusText>String</d2p1:ProcessStatusText>
      <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
      <d2p1:ReasonReturn>String</d2p1:ReasonReturn>
      <d2p1:SignBy>String</d2p1:SignBy>
      <d2p1:SignDate>0001-01-01T00:00:00</d2p1:SignDate>
      <d2p1:StatusId>0</d2p1:StatusId>
      <d2p1:StatusText>String</d2p1:StatusText>
      <d2p1:StepCount>0</d2p1:StepCount>
      <d2p1:StepOrder>0</d2p1:StepOrder>
      <d2p1:SubjectId>0</d2p1:SubjectId>
      <d2p1:SubjectText>String</d2p1:SubjectText>
      <d2p1:SubmitComment>String</d2p1:SubmitComment>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdateDocumentId>0</d2p1:UpdateDocumentId>
      <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
      <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
    </d2p1:DocumentSearchResultItem>
  </Data>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
</SearchResponse>