tvpl.api

<back to all web services

CreateCategoryRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/category/create
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 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 CreateCategoryResponse(IResponseRequest):
    id: int = 0
    code: int = 0
    message: Optional[str] = None


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

Python CreateCategoryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /category/create HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"code":0,"message":"String"}