tvpl.api

<back to all web services

UpdateCategoryOrderListRequest

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


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 CategoriesOrderList:
    id: int = 0
    sort_order: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCategoryOrderListRequest:
    type: Optional[CategoryTypes] = None
    order_list: Optional[List[CategoriesOrderList]] = None

Python UpdateCategoryOrderListRequest DTOs

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

HTTP + XML

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

POST /category/update-order-list HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateCategoryOrderListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <OrderList>
    <CategoriesOrderList>
      <Id>0</Id>
      <SortOrder>0</SortOrder>
    </CategoriesOrderList>
  </OrderList>
  <Type>Department</Type>
</UpdateCategoryOrderListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCategoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Id>0</Id>
  <Message>String</Message>
</CreateCategoryResponse>