Person (per)

The person entity stores information about an individual (human).

Database level

The entity's attributes are shown below. Mandatory fields are marked with a red star:

Name	Type	Description
form *	String	Represents the entity form. Will always be "per".
per_name *	String	The name of the person document composed from first name and last name (with an empty space in between).
per_org_unid *	String	The unique ID of the organisation document that the person works for. Is inherited from the organisation.
per_lastname *	String	The last name of the person document.
per_firstname *	String	The first name of the person document.
per_2firstname *	String	The unique ID of the person's participation document.
per_org_1name *	String	The name of the organisation that the person works for.
per_org_2name	String	The additional name of the organisation that the person works for.
per_org_name		The name of the organisation document composed from name and additional name (with an empty space in between). [per_org_1name per_org_2name]
per_org_business_state	String	Is inherited from the organisation that the person works for. It' always one of {active, inactive, potential, pasive }. For further details see online help.
per_org_shortname	String	Short name of the organisation that the person works for.
per_birthday_card	String	Stipulates if the contact can receive birthday cards. (e.g. "true", "false")
per_birthday_date	Time/Date	Stipulates the birthday of the contact if permitted. (e.g. "true", "false")
per_birthday_present	String	Stipulates if the contact may receive birthday presents. (e.g. "true", "false")
per_birth_city	String	Stipulates the birthday city of the contact.
per_birth_country	String	Stipulates the birthday country of the contact.
per_christmas_card	String	Stipulates if the contact can receive christmas cards. (e.g. "true", "false")
per_christmas_present	String	Stipulates if the contact may receive christmas presents. (e.g. "true", "false")
per_classification	String	Stipulates the person classification inherited from the organisation the contact belogs to, as code.
per_classification_text	String	Stipulates the person classification inherited from the organisation the contact belogs to, as label.
per_is_usr	String	Stipulates if the person an active user of the Synapcus Portal is or not. It will always be "1" for an active user and "Null" for not an active user.
per_main	String	Stipulates if the person is the main contact for the company which belongs to or not. Is a check-box and will always be one of {true, false}.
per_marketing_blacklist	String	Stipulates if the person agrees to receive marketing material or not. Is a check-box and will always be one of {true, false}.
per_marketing_blocklist	String	Stipulates if the contact should not receive any marketing materail. (e.g. "true", "false")
per_marketing_email	String	Stipulates if the person agrees to receive marketing material per email or not. Is a check-box and will always be one of {true, false}.
per_marketing_pos	String	Stipulates if the person agrees to receive marketing material per post or not. Is a check-box and will always be one of {true, false}.
per_nation	String	Stipulates the nationality of the person as part of the HRM Module.
per_org_dept	String	Stipulates the department name the contact belongs to into the organisation.
per_org_function	String	Stipulates the function the contact has to into the organisation.
per_ou1_name	String	1st Level Business Unit name of the organisation.
per_ou1_unid	String	The unique ID of the 1st Level Business Unit.
per_ou2_name	String	2nd Level Business Unit name of the organisation.
per_ou2_unid	String	The unique ID of the 2nd Level Business Unit.

QEE classes level

The class representing the person is QEEPer.

Inherits from: QEEObject, QEEContact.

REST level

The endpoints dealing with persons are:

xrPer (GET, POST, PUT, DELETE)

xrPers (GET, PUT, DELETE)

xrPerEval (GET)