Versions Compared

Old Version 7

changes.mady.by.user Justin

Saved on

compared with

New Version 8

changes.mady.by.user Justin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


NameDescription
1

Anchor
Add user
Add user
Add user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Add a new user account.

Name

Description
URL/user
HTTP MethodPOST
Body Parameters
ParameterDescription
idUser ID of user.
usernameUsername of user.
firstNameUser's first name.
lastNameUser's last name.
emailUser's email.
activeUser's account active status.
timeZoneUser's time zone.
localeUser's locale.
Sample Response
Code Block
languagejs
{
  "id": "apiUser",
  "username": "apiUser",
  "firstName": "API",
  "lastName": "User",
  "email": "",
  "active": 1,
  "timeZone": "",
  "locale": ""
}
2

Anchor
Delete user
Delete user
Delete user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Delete a user account.

Name

Description
URL/user/{username}
HTTP MethodDELETE
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
Code Block
languagejs
{
  "date": "Fri Aug 30 00:38:43 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
3

Anchor
Find HOD by username
Find HOD by username
Find HOD by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Find the HOD of the department that the specified user belongs to, via username.
4

Anchor
Find subordinate by username
Find subordinate by username
Find subordinate by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Find all users that report to the specified user, via username.
5

Anchor
Find user
Find user
Find user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get user details of all users by default.

Able to filter or sort the returned results via parameters.

6

Anchor
Get Department HOD
Get Department HOD
Get Department HOD

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get user details of the HOD of the department, via department ID.
7

Anchor
Get employment info
Get employment info
Get employment info

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get employment details of a user via username.
8

Anchor
Get roles by username
Get roles by username
Get roles by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get the roles (e.g: regular user or Joget administrator) of a user via username.
9

Anchor
Get user by username
Get user by username
Get user by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get user details of a user via username.
10

Anchor
Update user
Update user
Update user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Update the user details of a user.

...