tvpl.api

<back to all web services

UserUpdateProfileRequest

Requires Authentication
The following routes are available for this service:
POST/users/update-profile
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 UserUpdateProfileRequest:
    full_name: Optional[str] = None
    phone: Optional[str] = None
    birthday: datetime.datetime = datetime.datetime(1, 1, 1)
    avatar: 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 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 UserUpdateProfileRequest 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 /users/update-profile HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	fullName: String,
	phone: String,
	avatar: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	{
		id: 0,
		userName: String,
		fullName: String,
		name: String,
		email: String,
		departmentId: 0,
		phoneNumber: String,
		partyGroupId: 0,
		hrmsId: 0,
		avatar: String,
		birthday: "0001-01-01T00:00:00.0000000+07:06",
		isDelete: 0
	}
}