tvpl.api

<back to all web services

StatDocByGroupRequest

Requires Authentication
The following routes are available for this service:
POST/document/stat-search-by-group
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 StatDocByGroupRequest(SimpleSearchFilter, IPost):
    pass

Python StatDocByGroupRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /document/stat-search-by-group HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	title: String,
	groupId: 0,
	subjectId: 0,
	isUrgent: False,
	documentSearchStage: All,
	isInternal: False,
	fromDate: "0001-01-01T00:00:00.0000000+07:06",
	toDate: "0001-01-01T00:00:00.0000000+07:06",
	typeId: 0,
	statusId: 0,
	issuingAgencyId: 0,
	isParty: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalCount: 0,
	code: 0,
	data: 
	[
		{
			title: String,
			description: String,
			owner: String,
			documentPolicyId: 0,
			updateDocumentId: 0,
			effectBeginDate: "0001-01-01T00:00:00.0000000+07:06",
			effectEndDate: "0001-01-01T00:00:00.0000000+07:06",
			issuingAgencyId: 0,
			subjectId: 0,
			signBy: String,
			signDate: "0001-01-01T00:00:00.0000000+07:06",
			updatedAt: "0001-01-01T00:00:00.0000000+07:06",
			statusId: 0,
			isInternal: False,
			documentNumber: String,
			documentCode: String,
			isUrgent: False,
			id: 0,
			reasonReturn: String,
			accountId: 0,
			approverId: 0,
			updatedBy: String,
			createdBy: String,
			isParty: False,
			isRevisionRequested: False,
			isPrivate: False,
			departmentId: 0,
			publicationDate: "0001-01-01T00:00:00.0000000+07:06",
			processStatusId: 0,
			documentTypeId: 0,
			documentGroupId: 0,
			accountName: String,
			acceptAccountName: String,
			documentGroupText: String,
			processStatusText: String,
			documentTypeText: String,
			departmentText: String,
			statusText: String,
			issuingAgencyText: String,
			subjectText: String,
			comment: String,
			submitComment: String,
			fullFile: String,
			parthFile: String,
			isActive: False,
			stepOrder: 0,
			stepCount: 0
		}
	],
	message: String
}