PersonEvent

Authoritative Source: Banner

Properties: (View Raw Schema)

A table detailing the attributes and elements within the Person event stream object
Path Type Name Key Data Significant Attribute Occurrence Description
personData Object-Array personData     Exactly One Object containing person properties
personData.uin Element uin ✓   Exactly One UIN owner of person data
personData.pidm Element pidm     Exactly One Banner unique identifier for owner of person data
personData.nameList Object-Array nameList     Exactly One An array of name attribute groups, for each type associated with a person
personData.nameList.type Element type   ✓ Exactly One Type of name (e.g. Legal, Preferred, Published)
personData.nameList.prefix Element prefix   ✓ Exactly One Person's name prefix
personData.nameList.lastName Element lastName   ✓ Exactly One Person's last name
personData.nameList.firstName Element firstName   ✓ Exactly One Person's first name, for name type specified
personData.nameList.middleName Element middleName   ✓ Exactly One Person's middle name (omitted for preferred name)
personData.nameList.suffix Element suffix   ✓ Exactly One Person's name suffix
personData.birthDate Element birthDate   ✓ Exactly One Person's date of birth
personData.gender Element gender   ✓ Exactly One Person's gender. Valid values are: M - Male, F - Female, N - Unknown.
personData.confidential Element confidential   ✓ Exactly One Indicates whether a person has requested suppression of their directory data
personData.deceasedDate Element deceasedDate   ✓ Exactly One Person's deceased date
personData.deceasedInd Element deceasedInd   ✓ Exactly One Indicates whether a person is deceased
personData.citizenshipType Object-Array citizenshipType     Exactly One Object containing details about a person's citizenship type
personData.citizenshipType.code Element code   ✓ Exactly One Citizenship type code
personData.citizenshipType.description Element description     Exactly One Citizenship type description
personData.maritalStatus Object-Array maritalStatus     Exactly One Object containing details about a person's marital status
personData.maritalStatus.code Element code   ✓ Exactly One Marital status code
personData.maritalStatus.description Element description     Exactly One Marital status description
personData.race Object-Array race     Exactly One Object containing details about a person's race
personData.race.code Element code   ✓ Exactly One Race code
personData.race.description Element description     Exactly One Race description
personData.ethnicity Object-Array ethnicity     Exactly One Object containing details about a person's ethnicity
personData.ethnicity.code Element code   ✓ Exactly One Ethnicity code
personData.ethnicity.description Element description     Exactly One Ethnicity description