This article describes the HR API methods for handling business units.
GetUnits
This function returns information about Units within a deployment.
Request fields:
|
UserName |
Username of the person calling this web service |
|
UserPassword |
User password of the person calling this web service |
|
DeploymentID |
The unique customer deployment identifier (Provided by Nepton) |
|
WebServicePassword |
Password unique to the customer deployment (Provided by Nepton) |
|
IncludeDeletedUnits |
Possible value are True or False. True: If its value is ‘True’ then this web service returns all the units even the deleted ones. False: If its value is ‘False’ then it only returns the non-deleted units. |
Response fields:
| ErrorMessage | If the web service fails to get units information then this field contains the reason why it is not successful. |
| ReturnUnit > Id | Unit id |
| ReturnUnit > Code | Unit unique identifier |
| ReturnUnit > Name | Unit name |
| ReturnUnit > IsDeleted |
Possible value are True or False. True: unit is not active and is deleted False: unit is active |
| ReturnUnit > ModifiedDateTime | The date and time unit is last modified |