personData v 1.0.0

Properties

The personData model returns a person object with the following properties:

  • person
    • id
    • pidm
    • name
      • firstName
      • middleName
      • lastName
      • preferredName
    • gender
    • confidentiality
    • deceased
    • birthDate
    • ethnicity
    • emails[]
      • emailType
      • email
      • preferred
    • addresses[] (addressData)
    • phones[] (addressData)
    • campusHousing (addressData)
    • emergencyContacts[]
      • contactName
      • contactPhone
      • contactRelationship
      • contactPriority

Input Options

  • Required
    • token: valid authorization token
    • id: valid person ID
    • type: where type can be *, faculty/staff, or student

Helper Functions

  • emailObject getEmailByType(emailObject, emailType)
  • string getDisplayedFirstName(personObject)
  • long getStudentID(data)
    where data can be a pidm or email address
  • string getEthnicity(ethnicityCode)

Example

Model