Get a student curriculum row

get

/fscmRestApi/resources/11.13.18.05/studentCurriculums/{studentCurriculumsUniqID}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : studentCurriculums-item-response
Type: object
Show Source
  • Title: Academic Level ID
    Read Only: true
    The unique identifier for an academic level that's associated with the enrollment record.
  • Title: Academic Level Name
    Read Only: true
    Maximum Length: 100
    The name of an academic level that's associated with the enrollment record.
  • Title: Academic Period ID
    Read Only: true
    The unique identifier for the admit academic period of the student's academic group.
  • Title: Last Action Reason ID
    Read Only: true
    The unique identifier of action reason associated with the enrollment record.
  • Title: Action Reason
    Read Only: true
    Maximum Length: 50
    The name of the action reason associated with the enrollment record.
  • Title: 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.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
  • Title: End Date
    Read Only: true
    The date when the associated admit academic period ends.
  • Title: Academic Period ID
    Read Only: true
    The unique identifier of the academic period that's associated with admit date of the enrollment record.
  • Title: Period Name
    Read Only: true
    The name of the academic period that's associated with admit date of the enrollment record.
  • Title: Start Date
    Read Only: true
    The date when the associated admit academic period starts.
  • Title: Admit Date
    Read Only: true
    The admit date of the enrollment record.
  • Advisors
    Title: Advisors
    The advisors resource is a child of the student curriculum resource and provides a list of advisors assigned to a student.
  • 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.
  • Title: Student Program Approved Academic Load Meaning
    Read Only: true
    Maximum Length: 80
    The approved academic load meaning of the enrollment record. Valid values include Full time or Part time. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.
  • Title: Campus ID
    Read Only: true
    The unique identifier of the campus associated with the enrollment record.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the campus associated with the enrollment record.
  • Title: Credential Formal Name
    Read Only: true
    The formal name of the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.
  • Title: Credential ID
    Read Only: true
    The unique identifier for the credential marked as final and with the lowest display sequence value defined in the related curriculum program record.
  • Title: Curriculum ID
    Read Only: true
    The identifier for the program or academic group associated with this student curriculum item.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the program or academic group associated with this student curriculum item.
  • Title: Curriculum Item Type
    Read Only: true
    Maximum Length: 30
    The code of the type category of a curriculum item.
  • Title: Curriculum Type
    Read Only: true
    The unique identifier of the type category of a curriculum item.
  • Title: Student Curriculum Item ID
    Read Only: true
    The generated primary key column of the enrollment record.
  • Title: Enrollment Mode
    Read Only: true
    Maximum Length: 30
    The code of the enrollment mode that's used to enroll students in the program. Valid values include ORA_SCHEDULER or ORA_SHOPPING_CART. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
  • Title: Enrollment Mode Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the enrollment mode that's used to enroll students in the program. Valid values include Scheduler or Shopping Cart. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
  • Title: Final Credential
    Read Only: true
    Identifies a curriculum credential as the final or maximum credential when multiple credentials exist on a program.
  • Images
    Title: Images
    The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.
  • Title: Institution ID
    Read Only: true
    The unique identifier of the institution associated with the enrollment record.
  • Title: Institution
    Read Only: true
    Maximum Length: 50
    The name of the institution associated with the enrollment record.
  • Links
  • Title: Note
    Read Only: true
    The administrative note associated with the enrollment record.
  • Title: Parent Curriculum ID
    Read Only: true
    The unique identifier of the academic group associated with the program record.
  • Title: Academic Group Name
    Read Only: true
    Maximum Length: 50
    The name of the academic group associated with the program record.
  • Title: Payment Mode
    Read Only: true
    Maximum Length: 30
    The code of the payment mode that's used for the program when enrolling students. Valid values include ORA_PAY_TO_ENRL or ORA_BILL_LATER. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
  • Title: Payment Mode Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the payment mode that's used for the program when enrolling students. Valid values include Pay to enroll or Bill later. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
  • Title: Pay to access
    Read Only: true
    Maximum Length: 1
    Indicates that the student must pay the program fees before the student can enroll in courses.
  • Read Only: true
    Indicates whether the program is a primary program. The default value is: false.
  • Read Only: true
    Indicates whether the student has paid the program fees.
  • Read Only: true
    The date when the student's program started.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    The code of a program type that's associated with a program.
  • Title: Program Type ID
    Read Only: true
    The unique identifier for a program type that's associated with a program.
  • Title: Main program
    Read Only: true
    Maximum Length: 1
    Indicates whether a program is a main program.
  • Title: Program Type
    Read Only: true
    Maximum Length: 50
    The meaning of a program type that's associated with a program.
  • Title: Projected Completion Date
    Read Only: true
    The date when a student is expected to complete the program.
  • Title: Requirement Period End Date
    Read Only: true
    The date when the associated requirement academic period ends.
  • Title: Requirement Period ID
    Read Only: true
    The unique identifier of the academic period that's associated with the requirement period of the enrollment record.
  • Title: Requirement Period Name
    Read Only: true
    The name of the academic period that's associated with the requirement period of the enrollment record.
  • Title: Requirement Period Start Date
    Read Only: true
    The date when the associated requirement academic period starts.
  • Title: Start Date
    Read Only: true
    The date when the student's program or academic period started.
  • 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.
  • Title: Status Date
    Read Only: true
    The date of the latest status associated with the enrollment record.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
  • Student Academic Levels
    Title: Student Academic Levels
    The student academic levels resource is a child of the student curriculum resource and provides a list of academic levels calculated for a student under each reporting period.
  • 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.
  • Student Credentials
    Title: Student Credentials
    The student credentials resource is a child of the student curriculum resource and provides a list of credentials awarded to a student.
  • 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.
  • Title: Student Name
    Read Only: true
    Maximum Length: 450
    The name of the signed in student.
  • Title: Student ID
    Read Only: true
    The unique identifier assigned to a person whose association with an institution is classified as a 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 : Images
Type: array
Title: Images
The images resource is a child of the student curriculum resource and provides a list of image attachments for a student's program.
Show Source
Nested Schema : Student Academic Levels
Type: array
Title: Student Academic Levels
The student academic levels resource is a child of the student curriculum 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 the student curriculum 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 : studentCurriculums-advisors-item-response
Type: object
Show Source
  • Title: Advisor ID
    Read Only: true
    The generated primary key column of the advisor record.
  • Title: Advisor Name
    Read Only: true
    Maximum Length: 450
    The name of the advisor associated with the enrollment record.
  • Links
  • Title: Primary Advisor
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Identifies the primary advisor associated with the enrollment record.
Nested Schema : studentCurriculums-images-item-response
Type: object
Show Source
  • Title: Attachment Content
    Read Only: true
    The image associated with the student's program.
  • Title: Curriculum Attachment Context
    Read Only: true
    Maximum Length: 30
    The context or usage of the image associated with the program. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT.
  • Title: Curriculum Attachment ID
    Read Only: true
    A unique identifier for the image associated with the student's program.
  • Links
Nested Schema : studentCurriculums-studentAcademicLevels-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 30
    The student level at the start of an enrollment period.
  • Read Only: true
    Maximum Length: 30
    The student level at the end of an enrollment period.
  • Links
  • Read Only: true
    Maximum Length: 30
    The projected student level at the point of enrollment.
  • Title: Reporting Period End Date
    Read Only: true
    The date when the reporting period associated with a student enrollment record ended.
  • Title: Reporting Period ID
    Read Only: true
    The unique identifier of the reporting period associated with a student enrollment record.
  • Title: Reporting Period Name
    Read Only: true
    Maximum Length: 50
    The name of the reporting period associated with a student enrollment record.
  • Title: Reporting Period Start Date
    Read Only: true
    The date when the reporting period associated with a student enrollment record started.
Nested Schema : studentCurriculums-studentAcademicLoads-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 30
    The automatically-calculated academic load of the student, such as full-time or part-time.
  • Links
  • Read Only: true
    Maximum Length: 30
    The manually-assigned student academic load that supersedes the automatically-calculated value.
  • Title: Reporting Period End Date
    Read Only: true
    The date when the reporting period associated with a student enrollment record ended.
  • Title: Reporting Period ID
    Read Only: true
    The unique identifier of the reporting period associated with a student enrollment record.
  • Title: Reporting Period Name
    Read Only: true
    Maximum Length: 50
    The name of the reporting period associated with a student enrollment record.
  • Title: Reporting Period Start Date
    Read Only: true
    The date when the reporting period associated with a student enrollment record started.
Nested Schema : studentCurriculums-studentCredentials-item-response
Type: object
Show Source
  • Title: Student Credential Completion Period
    Read Only: true
    Maximum Length: 50
    The name of the academic period that's associated with completion of the enrollment record.
  • Title: Completion Period
    The unique identifier of the academic period that's associated with completion of the enrollment record.
  • Title: Student Credential Conferral Date
    The date when the credential was conferred to the student.
  • Title: Program Credential ID
    The unique identifier for the credential associated with the enrollment record.
  • Title: Credential Name
    Read Only: true
    Maximum Length: 50
    The name of the credential associated with the enrollment record.
  • Title: Credential ID
    The generated primary key column of the credential record.
  • Links
  • Title: Student Credential Note
    Read Only: true
    The administrative note associated with the credential.
  • Title: Status Code
    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.
  • Title: Status Date
    The date of the latest status associated with the credential.
  • Title: Meaning
    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.
  • Title: Student ID
    Read Only: true
    The unique identifier assigned to a person whose association with an institution is classified as a being a student.
Nested Schema : studentCurriculums-studentCurriculumElements-item-response
Type: object
Show Source
Back to Top