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

GET /DocumentPolicy HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	documentPolicy: 
	[
		{
			approvedDate: "0001-01-01T00:00:00.0000000+07:06",
			estimatedDeadline: "0001-01-01T00:00:00.0000000+07:06",
			isApproved: False,
			createdBy: 0,
			deletedAt: "0001-01-01T00:00:00.0000000+07:06",
			deletedBy: 0,
			approvalComment: String,
			isDeleted: False,
			lastUpdateAt: "0001-01-01T00:00:00.0000000+07:06",
			updatedBy: 0,
			id: 0,
			policyCode: String,
			title: String,
			documentLink: String,
			documentGroupId: 0,
			description: String,
			approvedBy: 0,
			departmentLeadId: 0,
			departmentCoId: 0
		}
	],
	unapprovedCount: 0,
	totalCount: 0
}