| GET | /document-template/search |
|---|
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 BasicDocument:
# @Required()
title: Optional[str] = None
# @StringLength(4000)
description: Optional[str] = None
# @StringLength(500)
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
document_type_id: Optional[int] = None
document_group_id: Optional[int] = None
subject_id: Optional[int] = None
# @StringLength(500)
sign_by: Optional[str] = None
sign_date: 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
scope_type: Optional[int] = None
is_active: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Document(BasicDocument):
id: int = 0
# @StringLength(500)
reason_return: Optional[str] = None
account_id: Optional[int] = None
deleted_at: Optional[datetime.datetime] = None
# @StringLength(500)
deleted_by: Optional[str] = None
# @StringLength(500)
updated_by: Optional[str] = None
created_at: Optional[datetime.datetime] = None
# @StringLength(500)
created_by: Optional[str] = None
is_party: Optional[bool] = None
is_revision_requested: bool = False
last_updated_at: Optional[datetime.datetime] = None
is_private: Optional[bool] = None
department_id: Optional[int] = None
publication_date: Optional[datetime.datetime] = None
process_status_id: Optional[int] = None
full_text_search_content: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentTemplate:
id: int = 0
# @Required()
title: Optional[str] = None
description: Optional[str] = None
is_active: bool = False
# @Ignore()
document_ids: Optional[List[int]] = None
# @Ignore()
documents: Optional[List[Document]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchDocumentTemplateResponse(IResponseRequest):
code: int = 0
message: Optional[str] = None
data: Optional[List[DocumentTemplate]] = None
total_count: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchTemplateRequest(PagingRequest):
title: Optional[str] = None
Python SearchTemplateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /document-template/search HTTP/1.1 Host: etc-api.vsmlab.vn Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchDocumentTemplateResponse 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:DocumentTemplate>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:Description>String</d2p1:Description>
<d2p1:DocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:DocumentIds>
<d2p1:Documents>
<d2p1:Document>
<d2p1:Description>String</d2p1:Description>
<d2p1:DocumentCode>String</d2p1:DocumentCode>
<d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
<d2p1:DocumentNumber>String</d2p1:DocumentNumber>
<d2p1:DocumentPolicyId>0</d2p1:DocumentPolicyId>
<d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
<d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
<d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:IsInternal>false</d2p1:IsInternal>
<d2p1:IsUrgent>false</d2p1:IsUrgent>
<d2p1:IssuingAgencyId>0</d2p1:IssuingAgencyId>
<d2p1:Owner>String</d2p1:Owner>
<d2p1:ScopeType>0</d2p1:ScopeType>
<d2p1:SignBy>String</d2p1:SignBy>
<d2p1:SignDate>0001-01-01T00:00:00</d2p1:SignDate>
<d2p1:StatusId>0</d2p1:StatusId>
<d2p1:SubjectId>0</d2p1:SubjectId>
<d2p1:Title>String</d2p1:Title>
<d2p1:UpdateDocumentId>0</d2p1:UpdateDocumentId>
<d2p1:AccountId>0</d2p1:AccountId>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>String</d2p1:CreatedBy>
<d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
<d2p1:DeletedBy>String</d2p1:DeletedBy>
<d2p1:DepartmentId>0</d2p1:DepartmentId>
<d2p1:FullTextSearchContent>String</d2p1:FullTextSearchContent>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsParty>false</d2p1:IsParty>
<d2p1:IsPrivate>false</d2p1:IsPrivate>
<d2p1:IsRevisionRequested>false</d2p1:IsRevisionRequested>
<d2p1:LastUpdatedAt>0001-01-01T00:00:00</d2p1:LastUpdatedAt>
<d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
<d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
<d2p1:ReasonReturn>String</d2p1:ReasonReturn>
<d2p1:UpdatedBy>String</d2p1:UpdatedBy>
</d2p1:Document>
</d2p1:Documents>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:Title>String</d2p1:Title>
</d2p1:DocumentTemplate>
</Data>
<Message>String</Message>
<TotalCount>0</TotalCount>
</SearchDocumentTemplateResponse>