Cezanne HROther ArticlesAPIAPI v1 DocumentationAPI v1: Communications (Deprecated)

API v1: Communications (Deprecated)

The Communications API enables all information from the People >> Personal Information >> Contact Details >> Communications tab for active and non active employees to be retrieve and modified through this API. The unique key for Communications is PERSONID.

Field Label Mandatory Comments
PERSONID Person Code Y  
PERSONNAME Name   Read only field. 
WORKPHONENUMBER Work Number    
WORKPHONEEXTENSION Work Number Ext.    
HOMEPHONENUMBER Home Number    
MOBILEPHONENUMBER Mobile Number    
OTHERPHONENUMBER Other Number    
FAXNUMBER Fax Number    
PAGERNUMBER Pager Number    
SKYPENAME Skype Name    
MESSENGERNAME Messenger    
INTERNALEMAILADDRESS Internal E-mail    
EXTERNALEMAILADDRESS External E-mail    
ALTERNATEEMAILADDRESS Alternate E-mail    
HTMLPREFERENCEINDICATOR HTML Preferred    
COMMENT Comments    

No navigation relations exist.

Security

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.