Search Disciplines by Student Academic Program ID Action

A field marked with an asterisk "*" indicates the field is a required input for this action.

This action returns a list of "Disciplines" (Academic Discipline, Discipline Status and start/end dates).

Input Fields

Field Description

Student Academic Program ID*

Is the Guid identifier of a student accademic program.

Can be retrieved using the Search Student Academic Programs by Person ID action.

Note: This is not Academic Program ID. For how to use this action, please refer to the “Add/Drop Major or Minor" example.

Status

The current state of a student's enrollment for a specific Academic Discipline (i.e. this refers to the Disciplines/Discipline Status/Status field).

Options include "all", "active", "inactive", and "complete".

  • Selecting one of "active", "inactive", or "complete" will filter the results by the selected option.
  • Selecting "All" will return all the disciplines.

This input is optional.

  • If this input is not included then we will retrieve and display all the student academic program's academic disciplines regardless of status.
  • If this input is added and left blank, we will treat the input value as empty string. In this case, workflow will not pass input validation since empty string is not a valid option.
  • If this input is added and passed with an empty token, we will return third-party error.

If a user wishes to use the research results for add/drop academic discipline, he/she should set the enrollment status to "active" programs since only active student academic programs are updateable.

Type

The type of the Academic Discipline.

Options include "all", "minor", "major" and "concentration".

  • Selecting one of "minor", "major", or "concentration" will filter the results by the selected option.
  • Selecting "all" will return all the disciplines.

This input is optional.

  • If this input is not included then we will retrieve and display all the student academic program's academic disciplines regardless of type.
  • If this input is added and left blank, we will treat the input value as empty string. In this case, workflow will not pass input validation since empty string is not a valid option.
  • If this input is added and passed with an empty token, we will return third-party error.

Output Fields

This action may return multiple results.

Field Description

Disciplines

The Academic Discipline is a collection. Each collection includes following fields.

Contains sub-fields.

ClosedSee the sub-fields.

  • Start On: The date on which the Academic Discipline begins for the student academic program. A Derived date based on the effective beginning terms of the SORLOS record and is not updatable.
  • End On: The date on which the Academic Discipline ends for the student academic program. A derived date based on the effective ending terms of the SORLOS record and is not updatable.
  • Override Start On: The date on which the Academic Discipline begins for the student academic program. May be used to provide a more refined detail of the dates the student was pursuing the discipline.
  • Override End On: The ending date of the Academic Discipline to be used for reporting. May be used to provide a more refined detail of the dates the student was pursuing the discipline.
  • Academic Discipline: Requires additional API call and includes sub-fields. (ClosedSee the Academic Discipline sub-fields).
    • Academic Discipline/Academic Discipline ID: The Guid identifier for the Academic Discipline under the student academic program.
    • Academic Discipline/Title: The full name of the Academic Discipline under the student academic program (for example, ‘Mathematics’).
    • Academic Discipline/Description: The full description of the Academic Discipline under the student academic program.
    • Academic Discipline/Type: The type of the Academic Discipline under the student academic program (for example, 'major').
    • Academic Discipline/Abbreviation: The abbreviation that identifies the Academic Discipline under the student academic program (for example, "MATH")
  • Discipline Status: Requires additional API call and includes sub-fields. (ClosedSee the Discipline Status sub-fields).
    • Discipline Status/Discipline Status ID: The Guid identifier for the Discipline Status.
    • Discipline Status/Title: The full name of the Discipline Status (for example, ‘Active Curriculum’).
    • Discipline Status/Description: The full description of the Discipline Status.
    • Discipline Status/Status: The type of the Academic Discipline (for example, 'active').
    • Discipline Status/Code: The code that identifies the Discipline Status (for example, "ACTIVE").