API docsAPI docs
  • English
  • zh-CN
  • English
  • zh-CN
    • Overview
    • Request & Response
    • Get Auth Token
    • Use Auth Token
    • Api Example
    • Area
    • Department
    • Position
    • Employee
    • Resign
    • Device
    • Transaction
    • Transaction Report

Department

List

Request

  • Method: GET

  • Url: /personnel/api/departments/

  • Headers:

    • Content-Type: application/json
    • Authorization: "JWT ey.........oQi98"
  • Query Parameters

ParameterDescription
pageWhich page is displayed
page_sizeShow the number of data on this page
dept_codeUse this field to query
dept_nameUse this field to query
dept_code_icontainsQuery the data that this field contains
dept_name_icontainsQuery the data that this field contains
orderingid, dept_code, dept_name

Response

{
    "count": 27,
    "next": "null",
    "previous": null,
    "msg": "",
    "code": 0,
    "data": [
        {
            "id": 1,
            "dept_code": "1",
            "dept_name": "WORLD",
            "parent_dept": null
        },
        {
            "id": 93,
            "dept_code": "5190062",
            "dept_name": "shenzhen",
            "parent_dept": null
        },
        ...
        ...
}

Read

Request

  • Method: GET

  • Url: /personnel/api/departments/{id}/

  • Headers:

    • Content-Type: application/json
    • Authorization: "JWT ey.........oQi98"
  • Path Parameters

ParameterDescription
idrequired

Response

- **Url:** /personnel/api/departments/1/
{
    "id": 1,
    "dept_code": "1",
    "dept_name": "WORLD",
    "parent_dept": null
}

Create

  • Method: POST
  • Url: /personnel/api/departments/
  • Headers:
    • Content-Type: application/json
    • Authorization: "JWT ey.........oQi98"
  • Request Body
{
    "dept_code": "test dept code",
    "dept_name": "test dept name",
    "parent_dept": null
}
ParameterRequiredTypeDescription
dept_codeYStringDepartment Code
dept_nameYStringDepartment Name
parent_deptNIntegerParent Department

Response

{
    "id": 100,
    "dept_code": "test dept code",
    "dept_name": "test dept name",
    "parent_dept": null
}

Update

Request

  • Method: PUT

  • Url: /personnel/api/departments/{id}/

  • Headers:

    • Content-Type: application/json
    • Authorization: "JWT ey.........oQi98"
  • Path Parameters

ParameterDescription
idrequired
  • Request Body
{
    "dept_code": "11",
    "dept_name": "test dept name",
}
ParameterRequiredTypeDescription
dept_codeYStringDepartment Code
dept_nameYStringDepartment Name
parent_deptNIntegerParent Department

Response

- **Url:** PUT /personnel/api/departments/1/
{
    "id": 1,
    "dept_code": "11",
    "dept_name": "WORLD WORLD",
    "parent_dept": null
}

Delete

Request

  • Method: DELETE

  • Url: /personnel/api/departments/{id}/

  • Headers:

    • Content-Type: application/json
    • Authorization: "JWT ey.........oQi98"
  • Path Parameters

ParameterDescription
idrequired

Response

None
Prev
Area
Next
Position