tvpl.api

<back to all web services

UpdateCategoryRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/category/update
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 UpdateCategoryRequest(CreateCategoryModel):
    id: int = 0
    is_deleted: Optional[bool] = None

Python UpdateCategoryRequest 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 /category/update HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	isDeleted: False,
	name: String,
	description: String,
	type: Department,
	isParty: False,
	childList: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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