tvpl.api

<back to all web services

SearchCategoryRequest

Requires Authentication
The following routes are available for this service:
POST/category
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 CategoryTypes(str, Enum):
    DEPARTMENT = 'Department'
    PARTY_GROUP = 'PartyGroup'
    DOC_GROUP = 'DocGroup'
    DOC_TYPE = 'DocType'
    ISSUING_AGENCY = 'IssuingAgency'
    STATUS = 'Status'
    SUBJECTS = 'Subjects'
    WORKFLOW = 'Workflow'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CategoryRequest:
    id: Optional[int] = None
    type: Optional[CategoryTypes] = None
    name: Optional[str] = None
    parent_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCategoryRequest(CategoryRequest):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateCategoryModel:
    name: Optional[str] = None
    description: Optional[str] = None
    type: Optional[CategoryTypes] = None
    is_party: bool = False
    # @Ignore()
    child_list: Optional[List[int]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Category(CreateCategoryModel):
    id: int = 0
    level: int = 0
    sort_order: int = 0
    last_update: Optional[datetime.datetime] = None
    # @Ignore()
    children: Optional[List[Category]] = None


List[any] = TypeVar('List[any]')


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

Python SearchCategoryRequest DTOs

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

HTTP + CSV

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

POST /category HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"type":"Department","name":"String","parentId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"code":0,"message":"String","data":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":null,"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}],"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}],"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}]}