Get a student curriculum row
get
/fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles/{PartyId}/child/studentCurriculums/{studentCurriculumsUniqID}
Request
Path Parameters
-
PartyId(required): integer(int64)
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=
-
studentCurriculumsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Curriculums resource and used to uniquely identify an instance of Student Curriculums. The client should not generate the hash key value. Instead, the client should query on the Student Curriculums collection resource in order to navigate to a specific instance of Student Curriculums to get the hash key.
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:
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.
Root Schema : searchHedPersonProfiles-studentCurriculums-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Read Only:
true
The unique identifier for an academic level that's associated with the enrollment record. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level that's 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 student curriculum 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's 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's associated with a program. -
ProgramTypeId: integer
(int64)
Read Only:
true
The unique identifier for a program type that's 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's 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 student curriculum 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 student curriculum 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 student curriculum 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 student curriculum 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 student curriculum 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 : 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-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's 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's 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's associated with a program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- advisors
-
Parameters:
- PartyId:
$request.path.PartyId
- studentCurriculumsUniqID:
$request.path.studentCurriculumsUniqID
The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student. - PartyId:
- studentAcademicLevels
-
Parameters:
- PartyId:
$request.path.PartyId
- studentCurriculumsUniqID:
$request.path.studentCurriculumsUniqID
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. - PartyId:
- studentAcademicLoads
-
Parameters:
- PartyId:
$request.path.PartyId
- studentCurriculumsUniqID:
$request.path.studentCurriculumsUniqID
The student academic loads resource is a child of the student curriculum resource and provides a list of academic loads calculated for a student under each reporting period. - PartyId:
- studentCredentials
-
Parameters:
- PartyId:
$request.path.PartyId
- studentCurriculumsUniqID:
$request.path.studentCurriculumsUniqID
The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student. - PartyId:
- studentCurriculumElements
-
Parameters:
- PartyId:
$request.path.PartyId
- studentCurriculumsUniqID:
$request.path.studentCurriculumsUniqID
The student curriculum elements resource is a child of the student curriculum resource and provides a list of programs enrolled for a student under an academic group. - PartyId: