tvpl.api

<back to all web services

SearchCategoryRequest

Requires Authentication
The following routes are available for this service:
POST/category
CategoryRequest Parameters:
NameParameterData TypeRequiredDescription
Idformint?No
TypeformCategoryTypes?No
NameformstringNo
ParentIdformint?No
CategoryTypes Enum:
Department
PartyGroup
DocGroup
DocType
IssuingAgency
Status
Subjects
Workflow
BaseResponse<List> Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringNo
DataformList<Category>No
Category Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LevelformintNo
SortOrderformintNo
LastUpdateformDateTime?No
ChildrenformList<Category>Yes
CreateCategoryModel Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
TypeformCategoryTypesNo
IsPartyformboolNo
ChildListformList<int>No

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":0,"type":"Department","name":"String","parentId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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]}]}