Org department APIs

Update org department

OVERVIEW

Overview

This API call is used to change a department within an organisation object in the system.

HTTP Request

PUT  /api/5/organisations/departments/<DEPTID>

URL Parameters
Parameter Description
DEPTID The department ID to be updated

 

HTTP Request Object

PUT http://example.com/context/api/5/organisations/departments/12

 

XML Request Example

<department>

<name>IT</name>

<status>active</status>

</department>

<department>
    <name>IT</name>
</department>

JSON Request Example

{
        "name": "IT",

        "status": "active"
}

HTTP Response
Success

HTTP response 200

Error

See API Error messages

 

Error messages

Summary Ref Code (V4) Ref Code (before V4)
This department name already exists 370  
The Department ID is invalid 349  
The department status is invalid. Please use the active status.  344  

Comments


0 Comments

Last Updated: Nov 08,2024