Get all person profiles
get
/fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all person profiles that match the Party ID, Party ID1, Person Profile ID, and Citizenship ID.
Finder Variables:- PartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
- searchByKeywords: Keyword to search from Name, Email ID, and Constituent ID.
Finder Variables:- keyword1; string.
- keyword2; string.
- PrimaryKey: Finds all person profiles that match the Party ID, Party ID1, Person Profile ID, and Citizenship ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdditionalFirstName; string; The additional first name of a person.
- AdditionalLastName; string; The additional last name of a person.
- AdditionalMiddleName; string; The additional middle name of a person.
- ConstituentId; string; The unique identifier for a constituent.
- DisplayFirstName; string; The display first name of a person.
- DisplayLastName; string; The display last name of a person.
- EmailAddress; string; The email address of the person.
- EmailId; integer; The unique identifier for an email address.
- FirstName; string; The first name of a person.
- FullName; string; The full name of the person.
- Gendercode; string; 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.
- Gendermeaning; string; The meaning of the gender code. A list of accepted values is defined in the lookup type ORA_HEY_GENDER.
- LastName; string; The last name of a person.
- MiddleName; string; The middle name of a person.
- NameSuffix; string; The suffix can be junior or senior.
- NameTypeCode; string; 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.
- PartyId; integer; The unique identifier for the party. Party can be a person. For example, a student can be a party.
- PartyNameId; integer; The unique identifier for a name.
- PreferredEmailFlag; boolean; Indicates the preferred email address.
- PreferredNameFlag; boolean; Indicates the name as preferred name for this party within this name type.
- PurposeCode; string; 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.
- Title; string; The title of the person, such as Mr or Mrs.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : searchHedPersonProfiles
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : searchHedPersonProfiles-item-response
Type:
Show Source
object
-
AdditionalFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The additional first name of a person. -
AdditionalLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The additional last name of a person. -
AdditionalMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The additional middle name of a person. -
ConstituentId: string
Title:
Constituent ID
Read Only:true
Maximum Length:30
The unique identifier for a constituent. -
DisplayFirstName: string
Read Only:
true
Maximum Length:150
The display first name of a person. -
DisplayLastName: string
Read Only:
true
Maximum Length:150
The display last name of a person. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the person. -
EmailId: integer
(int64)
Read Only:
true
The unique identifier for an email address. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of a person. -
FullName: string
Title:
Full Name
Read Only:true
Maximum Length:360
The full name of the person. -
Gendercode: string
Read Only:
true
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. -
Gendermeaning: string
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. -
images: array
Images
Title:
Images
The images resource is a child of search 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 a 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 a person. -
NameSuffix: string
Title:
Name Suffix
Read Only:true
Maximum Length:30
The suffix can be junior or senior. -
NameTypeCode: string
Title:
Name Type Code
Read Only:true
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. -
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. -
PartyNameId: integer
(int64)
Title:
Party Name ID
Read Only:true
The unique identifier for a name. -
phones: array
Phones
Title:
Phones
The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user. -
PreferredEmailFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the preferred email address. -
PreferredNameFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the name as preferred name for this party within this name type. -
PurposeCode: string
Title:
Purpose Code
Read Only:true
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. -
studentCredentials: array
Student Credentials
Title:
Student Credentials
The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student. -
studentCurriculums: array
Student Curriculums
Title:
Student Curriculums
The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student. -
Title: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the person, such as Mr or Mrs.
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of search person profiles resource and provides information about the image uploaded by the user.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Phones
Type:
array
Title:
Phones
The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user.
Show Source
Nested Schema : Student Credentials
Type:
array
Title:
Student Credentials
The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.
Show Source
Nested Schema : Student Curriculums
Type:
array
Title:
Student Curriculums
The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student.
Show Source
Nested Schema : searchHedPersonProfiles-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 : 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 : searchHedPersonProfiles-phones-item-response
Type:
Show Source
object
-
ContactPointType: string
Title:
Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type code of the contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number of the row. -
OwnerTableId: integer
(int64)
Read Only:
true
The unique identifier of the owner table. -
OwnerTableName: string
Read Only:
true
Maximum Length:30
The name of the owner table. -
PhoneAreaCode: string
Title:
Area Code
Read Only:true
Maximum Length:20
The area code within a country code. -
PhoneCountryCode: string
Title:
Phone Country Code
Read Only:true
Maximum Length:10
The international country code for a telephone number. For example, 33 for France. -
PhoneExtension: string
Title:
Extension
Read Only:true
Maximum Length:20
The extension number for a phone number. -
PhoneId: integer
(int64)
Read Only:
true
The unique identifier for the phone number. -
PhoneNumber: string
Title:
Phone
Read Only:true
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:
Primary
Read Only:true
Maximum Length:1
Default Value:false
Indicates the preferred phone number. -
PurposeCode: string
Title:
Purpose
Read Only:true
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. -
Status: string
Read Only:
true
Maximum Length:30
Default Value:A
Indicates the active phone number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : searchHedPersonProfiles-studentCredentials-item-response
Type:
Show Source
object
-
CompletionPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the academic period that is associated with completion of the enrollment record. -
ConferralDate: string
(date-time)
Title:
Conferral Date
Read Only:true
The date when the credential was conferred to the student. -
CredentialId: integer
(int64)
Title:
Program Credential ID
Read Only:true
The unique identifier for the credential associated with the enrollment record. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential associated with the enrollment record. -
EnrollmentCredentialId: integer
(int64)
Read Only:
true
The generated primary key column of the credential record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS. -
StatusDate: string
(date-time)
Title:
Status Date
Read Only:true
The date of the latest status associated with the credential. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS. -
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
Nested Schema : searchHedPersonProfiles-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. -
advisors: array
Advisors
Title:
Advisors
The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student. -
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. -
studentAcademicLevels: array
Student Academic Levels
Title:
Student Academic Levels
The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period. -
studentAcademicLoads: array
Student Academic Loads
Title:
Student Academic Loads
The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period. -
studentCredentials: array
Student Credentials
Title:
Student Credentials
The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student. -
studentCurriculumElements: array
Student Curriculum Elements
Title:
Student Curriculum Elements
The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group. -
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 : Advisors
Type:
array
Title:
Advisors
The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Student Academic Levels
Type:
array
Title:
Student Academic Levels
The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period.
Show Source
Nested Schema : Student Academic Loads
Type:
array
Title:
Student Academic Loads
The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period.
Show Source
Nested Schema : Student Credentials
Type:
array
Title:
Student Credentials
The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.
Show Source
Nested Schema : Student Curriculum Elements
Type:
array
Title:
Student Curriculum Elements
The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group.
Show Source
Nested Schema : searchHedPersonProfiles-studentCurriculums-advisors-item-response
Type:
Show Source
object
-
AdvisorId: integer
(int64)
Title:
Advisor ID
Read Only:true
The generated primary key column of the advisor record. -
AdvisorName: string
Title:
Advisor Name
Read Only:true
Maximum Length:450
The name of the advisor associated with the enrollment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
Primary Advisor
Read Only:true
Maximum Length:1
Default Value:false
Identifies the primary advisor associated with the enrollment record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : searchHedPersonProfiles-studentCurriculums-studentAcademicLevels-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Read Only:
true
The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate. -
AcademicLevelName: string
Read Only:
true
Maximum Length:50
The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate. -
BeginningAcademicLevel: string
Read Only:
true
Maximum Length:30
The student level at the start of an enrollment period. -
EndingAcademicLevel: string
Read Only:
true
Maximum Length:30
The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectedAcademicLevel: string
Read Only:
true
Maximum Length:30
The projected student level at the point of enrollment. -
ReportingPeriodEndDate: string
(date)
Read Only:
true
The date when the reporting period associated with a student enrollment record ended. -
ReportingPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the reporting period associated with a student enrollment record. -
ReportingPeriodName: string
Read Only:
true
Maximum Length:50
The name of the reporting period associated with a student enrollment record. -
ReportingPeriodStartDate: string
(date)
Read Only:
true
The date when the reporting period associated with a student enrollment record started.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : searchHedPersonProfiles-studentCurriculums-studentAcademicLoads-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:50
The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate. -
CalculatedAcademicLoad: string
Read Only:
true
Maximum Length:30
The automatically-calculated academic load of the student, such as full-time or part-time. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverriddenAcademicLoad: string
Read Only:
true
Maximum Length:30
The manually-assigned student academic load that supersedes the automatically-calculated value. -
ReportingPeriodEndDate: string
(date)
Title:
Reporting Period End Date
Read Only:true
The date when the reporting period associated with a student enrollment record ended. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Read Only:true
The unique identifier of the reporting period associated with a student enrollment record. -
ReportingPeriodName: string
Title:
Reporting Period Name
Read Only:true
Maximum Length:50
The name of the reporting period associated with a student enrollment record. -
ReportingPeriodStartDate: string
(date)
Title:
Reporting Period Start Date
Read Only:true
The date when the reporting period associated with a student enrollment record started.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : searchHedPersonProfiles-studentCurriculums-studentCredentials-item-response
Type:
Show Source
object
-
CompletionPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the academic period that is associated with completion of the enrollment record. -
ConferralDate: string
(date-time)
Title:
Conferral Date
Read Only:true
The date when the credential was conferred to the student. -
CredentialId: integer
(int64)
Title:
Program Credential ID
Read Only:true
The unique identifier for the credential associated with the enrollment record. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential associated with the enrollment record. -
EnrollmentCredentialId: integer
(int64)
Read Only:
true
The generated primary key column of the credential record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS. -
StatusDate: string
(date-time)
Title:
Status Date
Read Only:true
The date of the latest status associated with the credential. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS. -
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
Nested Schema : searchHedPersonProfiles-studentCurriculums-studentCurriculumElements-item-response
Type:
Show Source
object
-
CurriculumId: integer
(int64)
Title:
Curriculum ID
The identifier for the program associated with this student curriculum item. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the program 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
The unique identifier of the type category of a curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramEnrollmentId: integer
(int64)
Title:
Student Curriculum Item ID
The generated primary key column of the program enrollment record. -
ProgramTypeId: integer
(int64)
Title:
Program Type ID
Read Only:true
The unique identifier for a program type value 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 Name
Read Only:true
Maximum Length:50
The name of a program type value that is associated with a program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source