Org department APIs
Get org department
OVERVIEW
Overview
This API call is used to get a department from an organisation object in the system.
HTTP Request
GET /api/5/organisations/departments/<DEPTID>
URL Parameters
Parameter | Description |
DEPTID | The ID of the department |
HTTP Response
Success
HTTP response 200
Error
See API Error messages
Example
GET http://example.com/context/api/5/organisations/departments/3
XML format
<department>
<id>1</id>
<name>IT</name>
<status>Active</status>
<orgid>123</orgid>
</department>
JSON format
{
"id": "1",
"name": "IT",
"status": "Active",
"orgid": "123"
}
Error messages
Summary | Ref Code (V4) | Ref Code (before V4) |
Department ID is invalid | 349 | |
You do not have permissions to view this Department ID | 350 |
Last Updated: Nov 08,2024
Comments
0 Comments