The Addresses API enables all information from the People >> Personal Information >> Contact Details >> Addresses tab for active and non active employees to be retrieve and modified through this API. The unique key for Addresses is PERSONID, EFFECTIVEFROM, ADDRESSTYPEDESCRIPTION, ADDRESSLINEONE.
| Field | Label | Mandatory | Comments |
| PERSONID | Person Code | Y | |
| PERSONNAME | Name | Read only field | |
| EFFECTIVEFROM | Effective From | Y | |
| EFFECTIVETO | Effective To | Y | |
| ADDRESSTYPEDESCRIPTION | Address Type | Y | |
| ADDRESSLINEONE | Address Line 1 | Y | |
| ADDRESSLINETWO | Address Line 2 | ||
| ADDRESSLINETHREE | Address Line 3 | ||
| ADDRESSLINEFOUR | Address Line 4 | ||
| ADDRESSLINEFIVE | Address Line 5 | ||
| CITY | City | ||
| REGION | County | ||
| REGIONCODE | County Code | ||
| COUNTRYDESCRIPTION | Country | ||
| POSTCODE | Postcode | ||
| COMMENT | Comments |
The security for each role is defined in the following table:
| Security Role | Comments |
| HR Prof | Has full access to everyone within the system. |
| Restricted HR | Has access to people as defined by the user's security configuration. |
| Line Manager | Has read only access to their and all subordinate records. |
| Self Service | Has read only access to their record. |