1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Student Management Person Profiles

Update a person profile

patch

/fscmRestApi/resources/11.13.18.05/hedPersonProfiles/{PartyId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Addresses
    Title: Addresses
    The addresses resource provides information about the various addresses associated with the user.
  • Title: Country of Birth
    Maximum Length: 30
    The country where this person was born.
  • Citizenships
    Title: Citizenships
    Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.
  • Title: Citizenship Status
    Maximum Length: 30
    The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
  • Title: Citizenship Status Date
    The date from which the citizenship status was valid.
  • Title: Criminal History Explanation
    Maximum Length: 1000
    The description of any criminal history.
  • Title: Criminal History Indicator
    Maximum Length: 1
    Indicates whether criminal history exists for the person.
  • Title: Date of Birth
    The date when the person was born.
  • Title: Date of Death
    The date when the person died.
  • Title: Death Certificate Number
    Maximum Length: 100
    The death certificate number of the person.
  • Title: Person Deceased
    Maximum Length: 1
    Indicates if the person is deceased.
  • Emails
    Title: Emails
    The emails resource provides information about the various email addresses associated with the user.
  • Emergency Contacts
    Title: Emergency Contacts
    The emergency contacts resource provides information about the various emergency contacts provided by the user.
  • Title: Ethnicity
    Maximum Length: 30
    The unique code for ethnicity. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
  • Title: Ethnicity Value
    Maximum Length: 100
    The value of ethnicity for a person.
  • Title: Gender
    Maximum Length: 30
    The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.
  • Title: Gender Expression
    Maximum Length: 30
    The unique code for gender expression. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
  • Title: Gender Expression Value
    Maximum Length: 100
    The value of gender expression for a person.
  • Title: Gender Identity
    Maximum Length: 30
    The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
  • Title: Gender Identity Value
    Maximum Length: 100
    The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.
  • Title: Hispanic or Latino
    Maximum Length: 60
    The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
  • Images
    Title: Images
    The images resource provides information about the image uploaded by the user.
  • Title: Marital Status
    Maximum Length: 30
    The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.
  • Title: Marital Status as Of
    The date when the person's marital status changed.
  • Missing Person Contacts
    Title: Missing Person Contacts
    Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.
  • Names
    Title: Names
    The names resource provides information about the various names associated with the user.
  • National Identifiers
    Title: National Identifiers
    The national identifiers resource provides information about the various national identifiers associated with the user.
  • Phones
    Title: Phones
    The phones resource provides information about the various phone numbers associated with the user.
  • Title: Place of Birth
    Maximum Length: 60
    The place of birth of the student.
  • Title: Place of Death
    Maximum Length: 100
    The place of death of the person.
  • Title: Preferred Pronouns
    Maximum Length: 30
    The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
  • Title: Preferred Pronouns Value
    Maximum Length: 100
    The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.
  • Title: Primary Language
    Maximum Length: 30
    The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
  • Title: Primary Language Value
    Maximum Length: 100
    The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.
  • Title: Privacy Indicator
    Maximum Length: 1
    Indicates whether privacy restrictions are activated for this person. The default value is: true.
  • Races
    Title: Races
    The races resource provides information about the various races associated with the user.
  • Title: Country of Residence
    Maximum Length: 30
    The country this person normally resides in.
  • Title: School Discipline Explanation
    Maximum Length: 1000
    The description of any disciplinary action at another academic institution.
  • Title: School Discipline Indicator
    Maximum Length: 1
    Indicates whether the person has received disciplinary action at another academic institution.
  • Social Networks
    Title: Social Networks
    The social networks resource provides information about the various networks associated with the user.
  • Title: Visa Type
    Maximum Length: 30
    The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
Nested Schema : Addresses
Type: array
Title: Addresses
The addresses resource provides information about the various addresses associated with the user.
Show Source
Nested Schema : Citizenships
Type: array
Title: Citizenships
Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.
Show Source
Nested Schema : Emails
Type: array
Title: Emails
The emails resource provides information about the various email addresses associated with the user.
Show Source
Nested Schema : Emergency Contacts
Type: array
Title: Emergency Contacts
The emergency contacts resource provides information about the various emergency contacts provided by the user.
Show Source
Nested Schema : Images
Type: array
Title: Images
The images resource provides information about the image uploaded by the user.
Show Source
Nested Schema : Missing Person Contacts
Type: array
Title: Missing Person Contacts
Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.
Show Source
Nested Schema : Names
Type: array
Title: Names
The names resource provides information about the various names associated with the user.
Show Source
Nested Schema : National Identifiers
Type: array
Title: National Identifiers
The national identifiers resource provides information about the various national identifiers associated with the user.
Show Source
Nested Schema : Phones
Type: array
Title: Phones
The phones resource provides information about the various phone numbers associated with the user.
Show Source
Nested Schema : Races
Type: array
Title: Races
The races resource provides information about the various races associated with the user.
Show Source
Nested Schema : Social Networks
Type: array
Title: Social Networks
The social networks resource provides information about the various networks associated with the user.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Additional Address Element 5
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 1
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address line. Used in Japan.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Address Use Type
    The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.
  • Title: Building
    Maximum Length: 240
    The building name or number at a given address.
  • Title: City
    Maximum Length: 60
    The city for the address.
  • Title: Country Code
    Maximum Length: 2
    The country code from the TERRITORY_CODE column in the FND_TERRITORY table.
  • Title: County
    Maximum Length: 60
    The county for the address.
  • Title: Floor Number
    Maximum Length: 40
    The floor number at a given address or in a particular building when building number is provided.
  • Title: House Type
    Maximum Length: 30
    The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
  • Title: Location Directions
    Maximum Length: 640
    The directions to the location.
  • Title: Location ID
    The unique identifier for the location.
  • Title: Position
    Maximum Length: 50
    The primary direction such as North or East that's used to access the location.
  • Title: Postal Code
    Maximum Length: 60
    The postal code for the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States postal code.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred address. The default value is: false.
  • Title: Province Code
    Maximum Length: 60
    The province for the address.
  • Title: State Code
    Maximum Length: 60
    The state for the address.
Nested Schema : hedPersonProfiles-citizenships-item-patch-request
Type: object
Show Source
Nested Schema : hedPersonProfiles-emails-item-patch-request
Type: object
Show Source
Nested Schema : hedPersonProfiles-emergencyContacts-item-patch-request
Type: object
Show Source
  • Title: Additional Email
    Maximum Length: 1000
    The additional email for an emergency contact.
  • Title: Additional Email Type Code
    Maximum Length: 30
    The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Phone Area Code
    Maximum Length: 10
    The area code for additional phone of an emergency contact.
  • Title: Additional Phone Country Code
    Maximum Length: 10
    The country code for additional phone of an emergency contact.
  • Title: Additional Phone Extension
    Maximum Length: 10
    The extension for additional phone of an emergency contact.
  • Title: Additional Phone Number
    Maximum Length: 40
    The additional phone number for an emergency contact.
  • Title: Additional Phone Type Code
    Maximum Length: 30
    The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Contact Type Code
    Maximum Length: 30
    The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
  • Title: Email
    Maximum Length: 1000
    The email address of the emergency contact.
  • Title: Email Type Code
    Maximum Length: 30
    The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: First Name
    Maximum Length: 150
    The first name by which emergency contact is known.
  • Title: Last Name
    Maximum Length: 150
    The last name by which emergency contact is known.
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person.
  • Title: Name Suffix
    Maximum Length: 30
    The suffix can be junior or senior.
  • Title: Area Code
    Maximum Length: 10
    The country area code for the emergency contact phone number.
  • Title: Select Country
    Maximum Length: 10
    The international country code for the emergency contact phone number.
  • Title: Extension
    Maximum Length: 10
    The extension number for the emergency contact phone number.
  • Title: Phone
    Maximum Length: 40
    The emergency contact phone number.
  • Title: Phone Type Code
    Maximum Length: 30
    The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred emergency contact.
  • Title: Only One Name
    Maximum Length: 1
    Default Value: false
    Indicates if the person has single name.
  • Title: Title
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : schema
Type: object
Show Source
Nested Schema : hedPersonProfiles-missingPersonContacts-item-patch-request
Type: object
Show Source
  • Title: Additional Email
    Maximum Length: 1000
    The additional email for a missing person contact.
  • Title: Additional Email Type Code
    Maximum Length: 30
    The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Phone Area Code
    Maximum Length: 10
    The area code for additional phone of a missing person contact.
  • Title: Additional Phone Country Code
    Maximum Length: 10
    The country code for additional phone of a missing person contact.
  • Title: Additional Phone Extension
    Maximum Length: 10
    The extension for additional phone of a missing person contact.
  • Title: Additional Phone Number
    Maximum Length: 40
    The additional phone number for a missing person contact.
  • Title: Additional Phone Type Code
    Maximum Length: 30
    The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Relationship Type
    Maximum Length: 30
    The missing person contact type of the person, such as Spouse, Parent, and Grandparent. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
  • Title: Email
    Maximum Length: 1000
    The email for a missing person contact.
  • Title: Email Type Code
    Maximum Length: 30
    The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: First Name
    Maximum Length: 150
    The first name of a person.
  • Title: Last Name
    Maximum Length: 150
    The last name of a person.
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person.
  • Title: Name Suffix
    Maximum Length: 30
    The suffix can be junior or senior.
  • Title: Area Code
    Maximum Length: 10
    The area code within a country code.
  • Title: Phone Country Code
    Maximum Length: 10
    The country code for phone of a missing person contact.
  • Title: Phone Extension
    Maximum Length: 10
    The extension number for a phone number.
  • Title: Phone Number
    Maximum Length: 40
    The phone number formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Phone Type Code
    Maximum Length: 30
    The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred emergency contact.
  • Title: Only One Name
    Maximum Length: 1
    Default Value: false
    Indicates if the person has single name.
  • Title: Title
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : hedPersonProfiles-names-item-patch-request
Type: object
Show Source
Nested Schema : hedPersonProfiles-nationalIdentifiers-item-patch-request
Type: object
Show Source
Nested Schema : hedPersonProfiles-phones-item-patch-request
Type: object
Show Source
  • Title: Area Code
    Maximum Length: 20
    The area code within a country code.
  • Title: Country Code
    Maximum Length: 10
    The international country code for a phone number. For example, 33 for France.
  • Title: Phone Extension
    Maximum Length: 20
    The extension number for a phone number.
  • Title: Phone Type
    Maximum Length: 30
    Default Value: GEN
    The phone line type for phone contact, such as mobile and land. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.
  • Title: Phone Number
    Maximum Length: 40
    The phone number formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred phone number.
  • Title: Primary Phone Indicator
    Maximum Length: 1
    Default Value: false
    Indicates the primary phone number for a phone type.
  • Title: Purpose
    Maximum Length: 30
    The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
Nested Schema : hedPersonProfiles-races-item-patch-request
Type: object
Show Source
  • Title: Race
    Maximum Length: 30
    The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
  • Title: Race Value
    Maximum Length: 100
    The race value for a person.
Nested Schema : hedPersonProfiles-socialNetworks-item-patch-request
Type: object
Show Source
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred social network address.
  • Title: Provider
    Maximum Length: 30
    The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
  • Title: Provider
    The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
  • Title: Social Network Address
    Maximum Length: 200
    The social network address of the person.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : hedPersonProfiles-item-response
Type: object
Show Source
  • Addresses
    Title: Addresses
    The addresses resource provides information about the various addresses associated with the user.
  • Title: Country of Birth
    Maximum Length: 30
    The country where this person was born.
  • Title: Country of Birth
    Read Only: true
    Maximum Length: 80
    The name of the birth country code.
  • Citizenships
    Title: Citizenships
    Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.
  • Title: Citizenship Status
    Maximum Length: 30
    The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
  • Title: Citizenship Status Date
    The date from which the citizenship status was valid.
  • Title: Citizenship Status
    Read Only: true
    Maximum Length: 80
    The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
  • Title: Constituent ID
    Read Only: true
    Maximum Length: 30
    The unique identifier for a constituent.
  • Title: Criminal History Explanation
    Maximum Length: 1000
    The description of any criminal history.
  • Title: Criminal History Indicator
    Maximum Length: 1
    Indicates whether criminal history exists for the person.
  • Title: Date of Birth
    The date when the person was born.
  • Title: Date of Death
    The date when the person died.
  • Title: Death Certificate Number
    Maximum Length: 100
    The death certificate number of the person.
  • Title: Person Deceased
    Maximum Length: 1
    Indicates if the person is deceased.
  • Emails
    Title: Emails
    The emails resource provides information about the various email addresses associated with the user.
  • Emergency Contacts
    Title: Emergency Contacts
    The emergency contacts resource provides information about the various emergency contacts provided by the user.
  • Title: Ethnicity
    Maximum Length: 30
    The unique code for ethnicity. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
  • Title: Ethnicity
    Read Only: true
    Maximum Length: 80
    The meaning of ethnicity for a person. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
  • Title: Ethnicity Value
    Maximum Length: 100
    The value of ethnicity for a person.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of the person.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The full name of the person.
  • Title: Gender
    Maximum Length: 30
    The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.
  • Title: Gender Expression
    Maximum Length: 30
    The unique code for gender expression. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
  • Title: Gender Expression
    Read Only: true
    Maximum Length: 80
    The gender expression that defines how user shows their gender. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
  • Title: Gender Expression Value
    Maximum Length: 100
    The value of gender expression for a person.
  • Title: Gender Identity
    Maximum Length: 30
    The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
  • Title: Gender Identity
    Read Only: true
    Maximum Length: 80
    The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
  • Title: Gender Identity Value
    Maximum Length: 100
    The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.
  • Title: Gender
    Read Only: true
    Maximum Length: 80
    The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER.
  • Title: Hispanic or Latino
    Maximum Length: 60
    The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
  • Title: Hispanic or Latino
    Read Only: true
    Maximum Length: 80
    The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
  • Images
    Title: Images
    The images resource provides information about the image uploaded by the user.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name of the person.
  • Links
  • Title: Marital Status
    Maximum Length: 30
    The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.
  • Title: Marital Status as Of
    The date when the person's marital status changed.
  • Title: Marital Status
    Read Only: true
    Maximum Length: 80
    The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.
  • Title: Middle Name
    Read Only: true
    Maximum Length: 60
    The middle name of the person.
  • Missing Person Contacts
    Title: Missing Person Contacts
    Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.
  • Names
    Title: Names
    The names resource provides information about the various names associated with the user.
  • Title: Suffix
    Read Only: true
    Maximum Length: 30
    The name suffix of the person.
  • National Identifiers
    Title: National Identifiers
    The national identifiers resource provides information about the various national identifiers associated with the user.
  • Title: Party ID
    Read Only: true
    The unique identifier for the party. Party can be a person. For example, a student can be a party.
  • Phones
    Title: Phones
    The phones resource provides information about the various phone numbers associated with the user.
  • Title: Place of Birth
    Maximum Length: 60
    The place of birth of the student.
  • Title: Place of Death
    Maximum Length: 100
    The place of death of the person.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The preferred first name of the person.
  • Title: Full Name
    Read Only: true
    Maximum Length: 360
    The preferred full name of the person.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The preferred last name of the person.
  • Title: Middle Name
    Read Only: true
    Maximum Length: 60
    The preferred middle name of the person.
  • Title: Name Suffix
    Read Only: true
    Maximum Length: 30
    The preferred name suffix of the person.
  • Title: Preferred Pronouns
    Maximum Length: 30
    The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
  • Title: Preferred Pronouns
    Read Only: true
    Maximum Length: 80
    The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
  • Title: Preferred Pronouns Value
    Maximum Length: 100
    The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The preferred title of the person, such as Mr or Mrs.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The primary email address of the person.
  • Title: Primary Language
    Maximum Length: 30
    The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
  • Title: Primary Language
    Read Only: true
    Maximum Length: 80
    The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
  • Title: Primary Language Value
    Maximum Length: 100
    The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.
  • Title: Phone Area Code
    Read Only: true
    Maximum Length: 20
    The country area code for the primary phone number of the person.
  • Title: Phone Country Code
    Read Only: true
    Maximum Length: 10
    The international country code for the primary phone number of the person.
  • Title: Phone Extension
    Read Only: true
    Maximum Length: 20
    The extension number for the primary phone number of the person.
  • Title: Phone Number
    Read Only: true
    Maximum Length: 40
    The primary phone number of the person.
  • Title: Privacy Indicator
    Maximum Length: 1
    Indicates whether privacy restrictions are activated for this person. The default value is: true.
  • Races
    Title: Races
    The races resource provides information about the various races associated with the user.
  • Title: Country of Residence
    Maximum Length: 30
    The country this person normally resides in.
  • Title: Country of Residence
    Read Only: true
    Maximum Length: 80
    The name of the residency country code.
  • Title: School Discipline Explanation
    Maximum Length: 1000
    The description of any disciplinary action at another academic institution.
  • Title: School Discipline Indicator
    Maximum Length: 1
    Indicates whether the person has received disciplinary action at another academic institution.
  • Social Networks
    Title: Social Networks
    The social networks resource provides information about the various networks associated with the user.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
  • Title: User Name
    Read Only: true
    Maximum Length: 100
    The user name of the person.
  • Title: Visa Type
    Maximum Length: 30
    The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
  • Title: Visa Type
    Read Only: true
    Maximum Length: 80
    The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
Nested Schema : Addresses
Type: array
Title: Addresses
The addresses resource provides information about the various addresses associated with the user.
Show Source
Nested Schema : Citizenships
Type: array
Title: Citizenships
Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.
Show Source
Nested Schema : Emails
Type: array
Title: Emails
The emails resource provides information about the various email addresses associated with the user.
Show Source
Nested Schema : Emergency Contacts
Type: array
Title: Emergency Contacts
The emergency contacts resource provides information about the various emergency contacts provided by the user.
Show Source
Nested Schema : Images
Type: array
Title: Images
The images resource provides information about the image uploaded by the user.
Show Source
Nested Schema : Missing Person Contacts
Type: array
Title: Missing Person Contacts
Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.
Show Source
Nested Schema : Names
Type: array
Title: Names
The names resource provides information about the various names associated with the user.
Show Source
Nested Schema : National Identifiers
Type: array
Title: National Identifiers
The national identifiers resource provides information about the various national identifiers associated with the user.
Show Source
Nested Schema : Phones
Type: array
Title: Phones
The phones resource provides information about the various phone numbers associated with the user.
Show Source
Nested Schema : Races
Type: array
Title: Races
The races resource provides information about the various races associated with the user.
Show Source
Nested Schema : Social Networks
Type: array
Title: Social Networks
The social networks resource provides information about the various networks associated with the user.
Show Source
Nested Schema : hedPersonProfiles-addresses-item-response
Type: object
Show Source
Nested Schema : hedPersonProfiles-citizenships-item-response
Type: object
Show Source
Nested Schema : hedPersonProfiles-emails-item-response
Type: object
Show Source
  • Title: Email
    Maximum Length: 320
    The email address of the person.
  • Title: Email ID
    Read Only: true
    The unique identifier for an email address.
  • Links
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred email address.
  • Title: Purpose
    Maximum Length: 30
    The type of purpose for email contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Purpose
    Read Only: true
    Maximum Length: 80
    The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
Nested Schema : hedPersonProfiles-emergencyContacts-item-response
Type: object
Show Source
  • Title: Additional Email
    Maximum Length: 1000
    The additional email for an emergency contact.
  • Title: Additional Email Type Code
    Maximum Length: 30
    The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Email Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Phone Area Code
    Maximum Length: 10
    The area code for additional phone of an emergency contact.
  • Title: Additional Phone Country Code
    Maximum Length: 10
    The country code for additional phone of an emergency contact.
  • Title: Additional Phone Extension
    Maximum Length: 10
    The extension for additional phone of an emergency contact.
  • Title: Additional Phone Number
    Maximum Length: 40
    The additional phone number for an emergency contact.
  • Title: Additional Phone Type Code
    Maximum Length: 30
    The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Phone Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Contact Type Code
    Maximum Length: 30
    The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
  • Title: Relationship Type
    Read Only: true
    Maximum Length: 80
    The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
  • Title: Email
    Maximum Length: 1000
    The email address of the emergency contact.
  • Title: Email Type Code
    Maximum Length: 30
    The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Email Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Emergency Contact ID
    Read Only: true
    The unique identifier for emergency contact.
  • Title: First Name
    Maximum Length: 150
    The first name by which emergency contact is known.
  • Title: Last Name
    Maximum Length: 150
    The last name by which emergency contact is known.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person.
  • Title: Name Suffix
    Maximum Length: 30
    The suffix can be junior or senior.
  • Title: Area Code
    Maximum Length: 10
    The country area code for the emergency contact phone number.
  • Title: Select Country
    Maximum Length: 10
    The international country code for the emergency contact phone number.
  • Title: Extension
    Maximum Length: 10
    The extension number for the emergency contact phone number.
  • Title: Phone
    Maximum Length: 40
    The emergency contact phone number.
  • Title: Phone Type Code
    Maximum Length: 30
    The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Phone Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred emergency contact.
  • Title: Only One Name
    Maximum Length: 1
    Default Value: false
    Indicates if the person has single name.
  • Title: Title
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : hedPersonProfiles-images-item-response
Type: object
Show Source
Nested Schema : hedPersonProfiles-missingPersonContacts-item-response
Type: object
Show Source
  • Title: Additional Email
    Maximum Length: 1000
    The additional email for a missing person contact.
  • Title: Additional Email Type Code
    Maximum Length: 30
    The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Email Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Phone Area Code
    Maximum Length: 10
    The area code for additional phone of a missing person contact.
  • Title: Additional Phone Country Code
    Maximum Length: 10
    The country code for additional phone of a missing person contact.
  • Title: Additional Phone Extension
    Maximum Length: 10
    The extension for additional phone of a missing person contact.
  • Title: Additional Phone Number
    Maximum Length: 40
    The additional phone number for a missing person contact.
  • Title: Additional Phone Type Code
    Maximum Length: 30
    The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Additional Phone Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Relationship Type
    Maximum Length: 30
    The missing person contact type of the person, such as Spouse, Parent, and Grandparent. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
  • Title: Relationship Type
    Read Only: true
    Maximum Length: 80
    The meaning of missing person contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
  • Title: Email
    Maximum Length: 1000
    The email for a missing person contact.
  • Title: Email Type Code
    Maximum Length: 30
    The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Email Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: First Name
    Maximum Length: 150
    The first name of a person.
  • Title: Last Name
    Maximum Length: 150
    The last name of a person.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person.
  • Title: Missing Person Contact ID
    Read Only: true
    The unique identifier of a missing person contact.
  • Title: Name Suffix
    Maximum Length: 30
    The suffix can be junior or senior.
  • Title: Area Code
    Maximum Length: 10
    The area code within a country code.
  • Title: Phone Country Code
    Maximum Length: 10
    The country code for phone of a missing person contact.
  • Title: Phone Extension
    Maximum Length: 10
    The extension number for a phone number.
  • Title: Phone Number
    Maximum Length: 40
    The phone number formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Phone Type Code
    Maximum Length: 30
    The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Phone Type Name
    Read Only: true
    Maximum Length: 80
    The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred emergency contact.
  • Title: Only One Name
    Maximum Length: 1
    Default Value: false
    Indicates if the person has single name.
  • Title: Title
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : hedPersonProfiles-names-item-response
Type: object
Show Source
  • Title: First Name
    Maximum Length: 150
    The first name of a person.
  • Title: Full Name
    Maximum Length: 360
    The full name of the person.
  • Title: Last Name
    Maximum Length: 150
    The last name of a person.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    The middle name of a person.
  • Title: Name Suffix
    Maximum Length: 30
    The suffix can be junior or senior.
  • Title: Name Type
    Maximum Length: 30
    The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
  • Title: Name Type
    Read Only: true
    Maximum Length: 80
    The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
  • Title: Party Name ID
    Read Only: true
    The unique identifier for a name.
  • Title: Preferred
    Indicates the name as preferred name for this party within this name type.
  • Title: Only One Name
    Maximum Length: 1
    Default Value: false
    Indicates if the person has single name.
  • Title: Title
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : hedPersonProfiles-nationalIdentifiers-item-response
Type: object
Show Source
Nested Schema : hedPersonProfiles-phones-item-response
Type: object
Show Source
  • Links
  • Title: Area Code
    Maximum Length: 20
    The area code within a country code.
  • Title: Country Code
    Maximum Length: 10
    The international country code for a phone number. For example, 33 for France.
  • Title: Phone Extension
    Maximum Length: 20
    The extension number for a phone number.
  • Title: Phone ID
    Read Only: true
    The unique identifier for the phone number.
  • Title: Phone Type
    Maximum Length: 30
    Default Value: GEN
    The phone line type for phone contact, such as mobile and land. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.
  • Title: Phone Type
    Read Only: true
    Maximum Length: 80
    The meaning of the phone line type. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.
  • Title: Phone Number
    Maximum Length: 40
    The phone number formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred phone number.
  • Title: Primary Phone Indicator
    Maximum Length: 1
    Default Value: false
    Indicates the primary phone number for a phone type.
  • Title: Purpose
    Maximum Length: 30
    The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Purpose
    Read Only: true
    Maximum Length: 80
    The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
Nested Schema : hedPersonProfiles-races-item-response
Type: object
Show Source
  • Links
  • Title: Personal Race ID
    Read Only: true
    The unique identifier of person's race.
  • Title: Race
    Maximum Length: 30
    The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
  • Title: Race
    Read Only: true
    Maximum Length: 80
    The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
  • Title: Race Value
    Maximum Length: 100
    The race value for a person.
Nested Schema : hedPersonProfiles-socialNetworks-item-response
Type: object
Show Source
  • Links
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred social network address.
  • Title: Provider
    Maximum Length: 30
    The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
  • Title: Provider
    The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
  • Title: Social Network Address
    Maximum Length: 200
    The social network address of the person.
  • Title: Social Network ID
    Read Only: true
    The unique identifier for the social network.
Links
BirthCountryCodeLOV
Parameters:
  • finder: TerritoryCodeFinder%3BTerritoryCode%3D{BirthCountryCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: BirthCountryCode; Target Attribute: TerritoryCode
  • Display Attribute: TerritoryShortName
CitizenshipStatusLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_CITIZENSHIP_STATUS%2CLookupCode%3D{CitizenshipStatusCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: CitizenshipStatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
EthnicityCodeLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_DECLARED_ETHNICITY%2CLookupCode%3D{EthnicityCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: EthnicityCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
EthnicityLOV
Parameters:
  • finder: ByLookupTypeTagFinder%3BLookupType%3DORA_HEY_ETHNICITY%2CLookupCode%3D{HispanicOrLatinoCode}%2CTag%3DHEY_UI
The following properties are defined on the LOV link relation:
  • Source Attribute: HispanicOrLatinoCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
GenderExpressionCodeLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_GENDER_EXPRESSION%2CLookupCode%3D{GenderExpressionCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: GenderExpressionCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
GenderIdentityLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_GENDER_IDENTITY%2CLookupCode%3D{GenderIdentityCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: GenderIdentityCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
GenderLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupCode%3D{GenderCode}%2CLookupType%3DHZ_GENDER
The following properties are defined on the LOV link relation:
  • Source Attribute: GenderCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
MaritalStatusLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupCode%3D{MaritalStatusCode}%2CLookupType%3DMARITAL_STATUS
The following properties are defined on the LOV link relation:
  • Source Attribute: MaritalStatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
PreferredPronounsLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_PREFERRED_PRONOUN%2CLookupCode%3D{PreferredPronounsCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: PreferredPronounsCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
PrimaryLanguageLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_PRIMARY_LANGUAGE%2CLookupCode%3D{PrimaryLanguageCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: PrimaryLanguageCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
ResidenceCountryCodeLOV
Parameters:
  • finder: TerritoryCodeFinder%3BTerritoryCode%3D{ResidenceCountryCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: ResidenceCountryCode; Target Attribute: TerritoryCode
  • Display Attribute: TerritoryShortName
VisaTypeLOV
Parameters:
  • finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_VISA_TYPE%2CLookupCode%3D{VisaTypeCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: VisaTypeCode; Target Attribute: LookupCode
  • Display Attribute: Tag, Meaning
addresses
Parameters:
  • PartyId: $request.path.PartyId
The addresses resource provides information about the various addresses associated with the user.
citizenships
Parameters:
  • PartyId: $request.path.PartyId
Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.
emails
Parameters:
  • PartyId: $request.path.PartyId
The emails resource provides information about the various email addresses associated with the user.
emergencyContacts
Parameters:
  • PartyId: $request.path.PartyId
The emergency contacts resource provides information about the various emergency contacts provided by the user.
images
Parameters:
  • PartyId: $request.path.PartyId
The images resource provides information about the image uploaded by the user.
missingPersonContacts
Parameters:
  • PartyId: $request.path.PartyId
Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.
names
Parameters:
  • PartyId: $request.path.PartyId
The names resource provides information about the various names associated with the user.
nationalIdentifiers
Parameters:
  • PartyId: $request.path.PartyId
The national identifiers resource provides information about the various national identifiers associated with the user.
phones
Parameters:
  • PartyId: $request.path.PartyId
The phones resource provides information about the various phone numbers associated with the user.
races
Parameters:
  • PartyId: $request.path.PartyId
The races resource provides information about the various races associated with the user.
socialNetworks
Parameters:
  • PartyId: $request.path.PartyId
The social networks resource provides information about the various networks associated with the user.
Back to Top