Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

Department API can perform functions to interact or exchange data for Department.


NameDescription
1

Anchor
Add department
Add department
Add department

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Add a new department.

Name

Description
URL/
HTTP Method
GET
POST
Query String Parameters




Sample Response
Code Block
languagejs
2

Anchor
Delete department
Delete department
Delete department

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Delete a department via department ID.

Name

Description
URL/
HTTP Method
GET
DELETE
Query String Parameters




Sample Response
Code Block
languagejs
3

Anchor
Find department
Find department
Find department

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Gets all departments from all organizations by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/
HTTP MethodGET
Query String Parameters




Sample Response
Code Block
languagejs
4

Anchor
Get department by ID
Get department by ID
Get department by ID

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get details of a department via department ID.

Name

Description
URL/
HTTP MethodGET
Query String Parameters




Sample Response
Code Block
languagejs
5
Anchor
Update department
Update department
Update department
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Update the details of a department.

Name

Description
URL/
HTTP Method
GET
PUT
Query String Parameters




Sample Response
Code Block
languagejs