API v1: People (Deprecated)

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

Field Label Mandatory Comments
PERSONID Person Code Y  
FAMILYNAME Surname Y  
GIVENNAME First Name Y  
SALUTATIONDESCRIPTION Salutation    
GENDERDESCRIPTION Gender Y  
ACTIVEEMPLOYEE Active Employee?   Read-only field which indicates that the employee is currently an active employee. 1 means the person is active, 0 is a non-active employee 
BIRTHDATE Date of Birth Y  
ADDITIONALFAMILYNAMES Additional Family Name(s)   Read-only field containing additional family names. 
FAMILYNAMEPREFIX Family Name Prefix    
FORMATTEDNAME Full Name    
LEGALNAME Legal Name    
PREFERREDGIVENNAME Known As    
SUFFIXTITLE Suffix Title    
REGIONOFBIRTH County    
REGIONOFBIRTHCODE County Code    
COUNTRYOFBIRTHDESCRIPTION Country of Birth    
RESIDENCYCOUNTRYDESCRIPTION Country of Residence    
AGEMONTHS Age (Mths)    
AGEYEARS Age    
CITYOFBIRTH City of Birth    
COMMENTS Comments    
ETHNICORIGINDESCRIPTION Ethnic Origin    
MIDDLENAME Middle Name(s)    
MILITARYSTATUSDESCRIPTION Military Status    
NATIONALITYDESCRIPTION Nationality    
PRIMARYLANGUAGEDESCRIPTION Primary Language    
RACEDESCRIPTION Race    
THUMBNAIL Picture    
TOBACCOUSER Tobacco User    
DEATHDATE Deceased Date    
DECEASED Deceased    
STUDENT Student    

The following navigations are available from the People API entry.

Navigation Comments
PeopleToAddressesAll Return a history of all addresses.
PeopleToAddressesCurrent Return all current addresses.
PeopleToCommunications Return communications.
PeopleToDependants Return all dependants for a person.
PeopleToEmergencyContacts Return all Emergency contacts for a person.
PeopleToEmploymentAll Return all employment data.
PeopleToEmploymentCurrentPrimary Return the currently primary employment data for today.
PeopleToVisaDetailsAll Return all Visa Details for a person.
PeopleToVisaDetailsCurrent Return current Visa Details for a person.
PeopleToCompCurrent Return current Compensation for a person.
PeopleToCompAll Return all Compensation for a person.

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.

Examples

This section provides a number of examples on retrieving data from the API.

Return All People

To return all people including leavers and new hires who have not joined the following request can be made.

https://API-URL/CezanneOnDemand/DataService.svc/People

Return Active Employees

Return all active employees.

https://API-URL/CezanneOnDemand/DataService.svc/People?$filter=ACTIVEEMPLOYEE%20eq%201

Return Top 20 People

Return the top 20 people via the API.

https://API-URL/CezanneOnDemand/DataService.svc/People?$top=20

Return Selected Fields

Return all people who have 'ab'' in their surname, order by surname and only return the surname and first name of the employees.

https://API-URL/CezanneOnDemand/DataService.svc/People()?$filter=substringof('ab',tolower(FAMILYNAME))&$orderby=FAMILYNAME&$select=FAMILYNAME,GIVENNAME

Return Selected Person by Key

Return the person with a Person Code of CEZ01 using the key. Two example are provided, one returning XML and the other in JSON format.

 https://API-URL/CezanneOnDemand/DataService.svc/People('CEZ01') 
 https://API-URL/CezanneOnDemand/DataService.svc/People('CEZ01')?$format=json

Return the Current Primary Employment

Return the current primary employment information for a person with a code of CEZ01.

https://API-URL/CezanneOnDemand/DataService.svc/People('CEZ01')/PeopleToEmploymentCurrentPrimary