Get a person profile
get
/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}
Request
Path Parameters
-
PartyId(required): integer(int64)
The unique identifier for the party. Party can be a person. For example, a student can be a party.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : personProfiles-item-response
Type:
Show Source
object
-
academicHistories: array
Academic Histories
Title:
Academic Histories
The academic histories resource is a child of person profiles resource and provides information about the various academic histories associated with the user. -
addresses: array
Addresses
Title:
Addresses
The addresses resource is a child of the person profiles resource and provides information about the various addresses associated with the user. -
BirthCountryCode: string
Title:
Country of Birth
Maximum Length:30
The country where this person was born. -
BirthCountryName: string
Title:
Country of Birth
Read Only:true
Maximum Length:80
The name of the birth country code. -
CitizenshipCountryCode: string
Title:
Country of Citizenship
Maximum Length:2
The code for the country from which a person claims citizenship. -
CitizenshipCountryName: string
Title:
Country of Citizenship
Read Only:true
Maximum Length:80
The name of the citizenship country code. -
CitizenshipStatusCode: string
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. -
CitizenshipStatusDate: string
(date)
Title:
Citizenship Status Date
The date from which the citizenship status was valid. -
CitizenshipStatusMeaning: string
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. -
ConstituentId: string
Title:
Constituent ID
Read Only:true
Maximum Length:30
The unique identifier for a constituent. -
CriminalHistoryExplanation: string
Title:
Criminal History Explanation
Maximum Length:1000
The description of any criminal history. -
CriminalHistoryFlag: boolean
Title:
Criminal History Indicator
Maximum Length:1
Indicates whether criminal history exists for the person. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Place of Death
The date when the person died. -
DeathCertificateNumber: string
Title:
Death Certificate Number
Maximum Length:100
The death certificate number of the person. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates if the person is deceased. -
emails: array
Emails
Title:
Emails
The emails resource is a child of person profiles resource and provides information about the various email addresses associated with the user. -
emergencyContacts: array
Emergency Contacts
Title:
Emergency Contacts
The emergency contacts resource is a child of person profiles resource and provides information about the various emergency contacts provided by the user. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The full name of the person. -
GenderCode: string
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 ORA_HEY_GENDER. -
GenderIdentityCode: string
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. -
GenderIdentityMeaning: string
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. -
GenderIdentityValue: string
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'. -
GenderMeaning: string
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 ORA_HEY_GENDER. -
HigherEducationUserFlag: boolean
Title:
Higher Education User
Maximum Length:255
Indicates if the user is a higher education user. -
HispanicOrLatinoCode: string
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. -
HispanicOrLatinoMeaning: string
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: array
Images
Title:
Images
The images resource is a child of person profiles resource and provides information about the image uploaded by the user. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
learners: array
Learners
Title:
Learners
The learners resource is the child of personProfiles resource and provides information about the learner, and the relationship details of the corresponding proxy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaritalStatusCode: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup type ORA_HEY_MARITAL_STATUS. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status as Of
The date when the person's marital status changed. -
MaritalStatusMeaning: string
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 ORA_HEY_MARITAL_STATUS. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the person. -
names: array
Names
Title:
Names
The names resource is a child of person profiles resource and provides information about the various names associated with the user. -
NameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The name suffix of the person. -
nationalIdentifiers: array
National Identifiers
Title:
National Identifiers
The national identifiers resource is a child of person profiles resource and provides information about the various national identifiers associated with the user. -
PartyId: integer
(int64)
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: array
Phones
Title:
Phones
The phones resource is a child of person profiles resource and provides information about the various phone numbers associated with the user. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place of birth of the student. -
PlaceOfDeath: string
Title:
Place of Death
Maximum Length:100
The place of death of the person. -
PreferredFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The preferred first name of the person. -
PreferredFullName: string
Title:
Full Name
Read Only:true
Maximum Length:360
The preferred full name of the person. -
PreferredLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The preferred last name of the person. -
PreferredMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The preferred middle name of the person. -
PreferredNameSuffix: string
Title:
Name Suffix
Read Only:true
Maximum Length:30
The preferred name suffix of the person. -
PreferredPronounsCode: string
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. -
PreferredPronounsMeaning: string
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. -
PreferredPronounsValue: string
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'. -
PrimaryEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The primary email address of the person. -
PrimaryLanguageCode: string
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. -
PrimaryLanguageMeaning: string
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. -
PrimaryLanguageValue: string
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'. -
PrimaryPhoneAreaCode: string
Title:
Phone Area Code
Read Only:true
Maximum Length:20
The country area code for the primary phone number of the person. -
PrimaryPhoneCountryCode: string
Title:
Phone Country Code
Read Only:true
Maximum Length:10
The international country code for the primary phone number of the person. -
PrimaryPhoneExtension: string
Title:
Phone Extension
Read Only:true
Maximum Length:20
The extension number for the primary phone number of the person. -
PrimaryPhoneNumber: string
Title:
Phone Number
Read Only:true
Maximum Length:40
The primary phone number of the person. -
PrivacyFlag: boolean
Title:
Privacy Indicator
Maximum Length:1
Indicates whether privacy restrictions are activated for this person. The default value is: true. -
proxies: array
Proxies
Title:
Proxies
The proxies resource is the child of personProfiles resource and provides information about the proxy, and the relationship details of the corresponding learner. -
races: array
Races
Title:
Races
The races resource is a child of person profiles resource and provides information about the various races associated with the user. -
ResidenceCountryCode: string
Title:
Country of Residence
Maximum Length:30
The country this person normally resides in. -
ResidenceCountryName: string
Title:
Country of Residence
Read Only:true
Maximum Length:80
The name of the residency country code. -
SchoolDisciplineExplanation: string
Title:
School Discipline Explanation
Maximum Length:1000
The description of any disciplinary action at another academic institution. -
SchoolDisciplineFlag: boolean
Title:
School Discipline Indicator
Maximum Length:1
Indicates whether the person has received disciplinary action at another academic institution. -
securityRoles: array
Security Roles
Title:
Security Roles
The security roles resource returns all security roles with the user. -
socialNetworks: array
Social Networks
Title:
Social Networks
The social networks resource is a child of person profiles resource and provides information about the various networks associated with the user. -
studentCurriculums: array
Student Curriculums
Title:
Student Curriculums
The student curriculum resource is a child of person profiles resource and provides a list of academic groups and programs associated with a student. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:100
The user name of the person. -
VisaTypeCode: string
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. -
VisaTypeMeaning: string
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 : Academic Histories
Type:
array
Title:
Academic Histories
The academic histories resource is a child of person profiles resource and provides information about the various academic histories associated with the user.
Show Source
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource is a child of the person profiles resource and provides information about the various addresses associated with the user.
Show Source
Nested Schema : Emails
Type:
array
Title:
Emails
The emails resource is a child of person profiles resource and 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 is a child of person profiles resource and provides information about the various emergency contacts provided by the user.
Show Source
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of person profiles resource and provides information about the image uploaded by the user.
Show Source
Nested Schema : Learners
Type:
array
Title:
Learners
The learners resource is the child of personProfiles resource and provides information about the learner, and the relationship details of the corresponding proxy.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Names
Type:
array
Title:
Names
The names resource is a child of person profiles resource and 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 is a child of person profiles resource and provides information about the various national identifiers associated with the user.
Show Source
Nested Schema : Phones
Type:
array
Title:
Phones
The phones resource is a child of person profiles resource and provides information about the various phone numbers associated with the user.
Show Source
Nested Schema : Proxies
Type:
array
Title:
Proxies
The proxies resource is the child of personProfiles resource and provides information about the proxy, and the relationship details of the corresponding learner.
Show Source
Nested Schema : Races
Type:
array
Title:
Races
The races resource is a child of person profiles resource and provides information about the various races associated with the user.
Show Source
Nested Schema : Security Roles
Type:
array
Title:
Security Roles
The security roles resource returns all security roles with the user.
Show Source
Nested Schema : Student Curriculums
Type:
array
Title:
Student Curriculums
The student curriculum resource is a child of person profiles resource and provides a list of academic groups and programs associated with a student.
Show Source
Nested Schema : personProfiles-academicHistories-item-response
Type:
Show Source
object
-
AcademicHistoriesId: integer
(int64)
Title:
Academic History ID
The unique identifier for academic history. -
DegreeEarned: string
Title:
Degree Earned
Maximum Length:200
The degree or qualification which the student earned. -
EntryDate: string
(date)
Title:
Entry Date
The date when the student was admitted to the external organization. -
GraduationDate: string
(date)
Title:
Graduation Date
The date when the student graduated. -
GraduationFlag: boolean
Title:
Graduation Indicator
Maximum Length:1
Indicates whether the student graduated from the external organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationPartyId: integer
(int64)
Title:
Organization Party ID
The unique identifier for a trading community party of the external organization. -
OrganizationPartyName: string
Title:
Organization Party Name
Read Only:true
The name of the external organization. -
OriginSystemCode: string
Title:
Code for Data Source
Maximum Length:30
The code for the third party source where this data row originated. A list of accepted values is defined in the lookup type ORA_HEY_ORIGIN_SYSTEM. -
OriginSystemMeaning: string
Title:
Data Source
Read Only:true
Maximum Length:80
The meaning of the origin system code. A list of accepted values is defined in the lookup type ORA_HEY_ORIGIN_SYSTEM. -
OriginSystemReference: string
Title:
Data Source Reference
Maximum Length:255
The primary reference key for this data row in the third party source.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : personProfiles-addresses-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
AddressOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressUseId: integer
(int64)
Title:
Address Use ID
Read Only:true
The unique identifier for party usage. -
AddressUseTypeCode: string
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 ORA_HEY_PARTY_SITE_USE. -
AddressUseTypeMeaning: string
Title:
Address Use Type
Read Only:true
Maximum Length:80
The meaning of the site use type code. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
Building: string
Title:
Building
Maximum Length:240
The building name or number at a given address. -
City: string
Title:
City
Maximum Length:60
The city for the address. -
CountryCode: string
Title:
Country Code
Maximum Length:2
The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county for the address. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The end date for the address row. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
The floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The address formatted based on the country code. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The multi line display for the formatted address. -
FutureAddressFlag: boolean
Title:
Future Address Indicator
Read Only:true
Maximum Length:1
Indicates that the address is future dated. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Title:
House Type
Read Only:true
Maximum Length:80
The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
PartyAddressId: integer
(int64)
Title:
Party Address ID
Read Only:true
The unique identifier for party address. -
Position: string
Title:
Position
Maximum Length:50
The primary direction such as North or East that is used to access the location. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code for the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States postal code. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred address. The default value is: false. -
Province: string
Title:
Province Code
Maximum Length:60
The province for the address. -
StartDate: string
(date)
Title:
Start Date
The start date for the address row. -
StateCode: string
Title:
State Code
Maximum Length:60
The state for the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-emails-item-response
Type:
Show Source
object
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the person. -
EmailId: integer
(int64)
Title:
Email ID
Read Only:true
The unique identifier for an email address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred email address. -
PurposeCode: string
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 ORA_HEY_EMAIL_CONTACT_PURPOSE. -
PurposeMeaning: string
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 ORA_HEY_EMAIL_CONTACT_PURPOSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-emergencyContacts-item-response
Type:
Show Source
object
-
AdditionalEmail: string
Maximum Length:
1000
The additional email for an emergency contact. -
AdditionalEmailTypeCode: string
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. -
AdditionalEmailTypeMeaning: string
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. -
AdditionalPhoneAreaCode: string
Maximum Length:
10
The area code for additional phone of an emergency contact. -
AdditionalPhoneCountryCode: string
Maximum Length:
10
The country code for additional phone of an emergency contact. -
AdditionalPhoneExtension: string
Maximum Length:
10
The extension for additional phone of an emergency contact. -
AdditionalPhoneNumber: string
Maximum Length:
40
The additional phone number for an emergency contact. -
AdditionalPhoneTypeCode: string
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. -
AdditionalPhoneTypeMeaning: string
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. -
ContactTypeCode: string
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. -
ContactTypeMeaning: string
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. -
Email: string
Title:
Email
Maximum Length:1000
The email address of the emergency contact. -
EmailTypeCode: string
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. -
EmailTypeMeaning: string
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. -
EmergencyContactId: integer
(int64)
Title:
Emergency Contact ID
Read Only:true
The unique identifier for emergency contact. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name by which emergency contact is known. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name by which emergency contact is known. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Maximum Length:
60
The middle name of the person. -
NameSuffix: string
Maximum Length:
30
The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The country area code for the emergency contact phone number. -
PhoneCountryCode: string
Title:
Select Country
Maximum Length:10
The international country code for the emergency contact phone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:10
The extension number for the emergency contact phone number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The emergency contact phone number. -
PhoneTypeCode: string
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. -
PhoneTypeMeaning: string
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. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred emergency contact. -
SingleNameFlag: boolean
Title:
Only One Name
Maximum Length:1
Default Value:false
Indicates if the person has single name. -
Title: string
Maximum Length:
60
The title of the person, such as Mr or Mrs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-images-item-response
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
The binary representation of the attachment. -
ImageId: integer
(int64)
Title:
Attachment ID
Read Only:true
The unique identifier for image. -
ImageName: string
Maximum Length:
240
The name of the image. -
ImageTypeCode: string
Title:
Attachment Type Code
Read Only:true
Maximum Length:30
Default Value:PROFILE_PHOTO
The type code of the attachment, for example, STUDENT_PHOTO and INSTRUCTOR_PHOTO. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-learners-item-response
Type:
Show Source
object
-
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the person was born. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The full name of the person. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
LearnerPartyId: integer
(int64)
Title:
Learner Party ID
Read Only:true
The unique identifier for the party. Party is a learner here. -
LearnerRelationshipId: integer
(int64)
Title:
Learner Relationship ID
Read Only:true
The unique identifier for a learner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the person. -
ProxyToLearnerRelationshipCode: string
Title:
Learner Relationship Code
Read Only:true
Maximum Length:30
A unique code for the relationship between the proxy and the learner. -
ProxyToLearnerRelationshipMeaning: string
Title:
Learner Relationship Meaning
Read Only:true
Maximum Length:80
The description of the relationship code. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:100
The user name of the person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-names-item-response
Type:
Show Source
object
-
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
FullName: string
Title:
Full Name
Maximum Length:360
The full name of the person. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of a person. -
NameSuffix: string
Title:
Name Suffix
Maximum Length:30
The suffix can be junior or senior. -
NameTypeCode: string
Title:
Name Type
Maximum Length:30
The type of the name. It is 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. -
NameTypeMeaning: string
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. -
PartyNameId: integer
(int64)
Title:
Party Name ID
Read Only:true
The unique identifier for a name. -
PreferredFlag: boolean
Title:
Preferred
Indicates the name as preferred name for this party within this name type. -
SingleNameFlag: boolean
Title:
Only One Name
Maximum Length:1
Default Value:false
Indicates if the person has single name. -
Title: string
Title:
Title
Maximum Length:60
The title of the person, such as Mr or Mrs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-nationalIdentifiers-item-response
Type:
Show Source
object
-
Authority: string
Title:
Authority
Maximum Length:100
The authority who issues the person national identifier. -
CountryCode: string
Title:
Country Code
Maximum Length:30
The country code for national identifier of the person. -
CountryName: string
Title:
Country Name
Read Only:true
Maximum Length:80
The country name for national identifier of the person. -
ExpirationDate: string
(date)
Title:
Expiration Date
The expiration date of the person national identifier. -
IdentifierTypeCode: string
Title:
Identifier Type Code
Maximum Length:30
The identifier type code for national identifier of the person. -
IdentifierTypeMeaning: string
Title:
Identifier Type
Read Only:true
Maximum Length:60
The meaning of identifier type code for national identifier of the person. -
IdentifierValue: string
Title:
ID Number
Maximum Length:30
The identifier value of the person. -
IssueDate: string
(date)
Title:
Issue Date
The issue date of the person national identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalIdentifierId: integer
(int64)
Title:
National Identifier ID
Read Only:true
The unique identifier for the national identifier. -
Notes: string
Title:
Note
Maximum Length:240
The additional notes for person national identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-phones-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code within a country code. -
PhoneCountryCode: string
Title:
Country Code
Maximum Length:10
The international country code for a telephone number. For example, 33 for France. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
The extension number for a phone number. -
PhoneId: integer
(int64)
Title:
Phone ID
Read Only:true
The unique identifier for the phone number. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
The telephone number formatted in the local format. The number should not include area code, country code, or extension. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred phone number. -
PurposeCode: string
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 ORA_HEY_PHONE_CONTACT_PURPOSE. -
PurposeMeaning: string
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 ORA_HEY_PHONE_CONTACT_PURPOSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-proxies-item-response
Type:
Show Source
object
-
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The full name of the person. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the person. -
ProxyPartyId: integer
(int64)
Title:
Proxy Party ID
Read Only:true
The unique identifier of the party. The party is a proxy to a learner here. -
ProxyRelationshipId: integer
(int64)
Title:
Proxy Relationship ID
Read Only:true
The unique identifier of the proxy's relationship with a learner. -
ProxyToLearnerRelationshipCode: string
Title:
Proxy Relationship Code
Read Only:true
Maximum Length:30
A unique code for the relationship between the proxy and the learner. -
ProxyToLearnerRelationshipMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The description of the relationship code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-races-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonalRaceId: integer
(int64)
Title:
Personal Race ID
Read Only:true
The unique identifier of person's race. -
RaceCode: string
Title:
Race
Maximum Length:30
The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE. -
RaceCodeMeaning: string
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. -
RaceValue: string
Maximum Length:
100
The race value for a person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-securityRoles-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the security role. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleCode: string
Title:
Role Code
Read Only:true
Maximum Length:240
The alternate identifier for the security role. -
RoleId: integer
(int64)
Title:
Role ID
Read Only:true
The unique identifier for the security role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
The name of the security role. -
UserRoleId: integer
(int64)
Read Only:
true
The unique identifier for the user role.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProfiles-studentCurriculums-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Read Only:
true
The unique identifier for an academic level that is associated with the enrollment record. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level that is associated with the enrollment record. -
ActionReasonId: integer
(int64)
Title:
Last Action Reason ID
Read Only:true
The unique identifier of action reason associated with the enrollment record. -
ActionTypeCode: string
Title:
Last Action
Read Only:true
Maximum Length:30
The code of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE. -
ApprovedAcademicLoad: string
Title:
Student Program Approved Academic Load
Read Only:true
Maximum Length:30
The approved academic load code of the enrollment record. Valid values include ORA_FULL_TIME or ORA_PART_TIME. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE. -
CampusId: integer
(int64)
Title:
Campus ID
Read Only:true
The unique identifier of the campus associated with the enrollment record. -
CampusName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the campus associated with the enrollment record. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The identifier for the program or academic group associated with this student curriculum item. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the program or academic group associated with this student curriculum item. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The code of the type category of a curriculum item. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type
Read Only:true
The unique identifier of the type category of a curriculum item. -
EnrollmentId: integer
(int64)
Title:
Student Curriculum Item ID
Read Only:true
The generated primary key column of the enrollment record. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The unique identifier of the institution associated with the enrollment record. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution associated with the enrollment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentAcademicGroupId: integer
(int64)
Read Only:
true
The unique identifier of the academic group associated with the program record. -
ParentAcademicLevelId: integer
Read Only:
true
The unique identifier of the academic level associated with the program record. -
PrimaryProgramFlag: boolean
Read Only:
true
Indicates whether the program is a primary program. The default value is: false. -
ProgramAdmitAcademicPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the academic period that is associated with admit date of the enrollment record. -
ProgramAdmitDate: string
(date)
Read Only:
true
The admit date of the enrollment record. -
ProgramStartDate: string
(date)
Read Only:
true
The date when the student???s program started. -
ProgramStatus: string
Read Only:
true
Maximum Length:30
Indicates the active program. -
ProgramTypeCode: string
Title:
Code
Read Only:true
Maximum Length:30
The code of a program type that is associated with a program. -
ProgramTypeId: integer
(int64)
Read Only:
true
The unique identifier for a program type that is associated with a program. -
ProgramTypeMainFlag: boolean
Title:
Main program
Read Only:true
Maximum Length:1
Indicates whether a program is a main program. -
ProgramTypeName: string
Title:
Program Type
Read Only:true
Maximum Length:50
The meaning of a program type that is associated with a program. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Read Only:true
The date when a student is expected to complete the program. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
The code of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS. -
StatusDate: string
(date-time)
Title:
Status Date
Read Only:true
The date of the latest status associated with the enrollment record. -
StudentPartyId: integer
(int64)
Title:
Student ID
Read Only:true
The unique identifier assigned to a person whose association with an institution is classified as being a student.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- 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
- finder:
- EthnicityLOV
-
Parameters:
- finder:
ByLookupTypeTagFinder%3BLookupType%3DORA_HEY_ETHNICITY%2CTag%3DHEY_UI
The following properties are defined on the LOV link relation:- Source Attribute: HispanicOrLatinoCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- TerritoryLOV
-
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: Meaning, Tag
- finder:
- academicHistories
-
Parameters:
- PartyId:
$request.path.PartyId
The academic histories resource is a child of person profiles resource and provides information about the various academic histories associated with the user. - PartyId:
- addresses
-
Parameters:
- PartyId:
$request.path.PartyId
The addresses resource is a child of the person profiles resource and provides information about the various addresses associated with the user. - PartyId:
- emails
-
Parameters:
- PartyId:
$request.path.PartyId
The emails resource is a child of person profiles resource and provides information about the various email addresses associated with the user. - PartyId:
- emergencyContacts
-
Parameters:
- PartyId:
$request.path.PartyId
The emergency contacts resource is a child of person profiles resource and provides information about the various emergency contacts provided by the user. - PartyId:
- images
-
Parameters:
- PartyId:
$request.path.PartyId
The images resource is a child of person profiles resource and provides information about the image uploaded by the user. - PartyId:
- learners
-
Parameters:
- PartyId:
$request.path.PartyId
The learners resource is the child of personProfiles resource and provides information about the learner, and the relationship details of the corresponding proxy. - PartyId:
- names
-
Parameters:
- PartyId:
$request.path.PartyId
The names resource is a child of person profiles resource and provides information about the various names associated with the user. - PartyId:
- nationalIdentifiers
-
Parameters:
- PartyId:
$request.path.PartyId
The national identifiers resource is a child of person profiles resource and provides information about the various national identifiers associated with the user. - PartyId:
- phones
-
Parameters:
- PartyId:
$request.path.PartyId
The phones resource is a child of person profiles resource and provides information about the various phone numbers associated with the user. - PartyId:
- proxies
-
Parameters:
- PartyId:
$request.path.PartyId
The proxies resource is the child of personProfiles resource and provides information about the proxy, and the relationship details of the corresponding learner. - PartyId:
- races
-
Parameters:
- PartyId:
$request.path.PartyId
The races resource is a child of person profiles resource and provides information about the various races associated with the user. - PartyId:
- securityRoles
-
Parameters:
- PartyId:
$request.path.PartyId
The security roles resource returns all security roles with the user. - PartyId:
- socialNetworks
-
Parameters:
- PartyId:
$request.path.PartyId
The social networks resource is a child of person profiles resource and provides information about the various networks associated with the user. - PartyId:
- studentCurriculums
-
Parameters:
- PartyId:
$request.path.PartyId
The student curriculum resource is a child of person profiles resource and provides a list of academic groups and programs associated with a student. - PartyId: