Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PERSON_INSTRUCTION_READ

ReturnsList<ExternalPersonLiteTO>

List<ExternalFacultyCourseRosterTO>

Warning

GET to/ssp/api/1/person/{facultySchoolId}/instruction/course/{formattedCourse}/roster is strongly encouraged to include a termCode query parameter.

E.g. a GET/ssp/api/1/person/coach001/instruction/course/DEV-MTH-101/roster?termCode=FA12 will return the same result as shown above. If termCode is not sent and formattedCourse values are not distinct for each term, application behavior is not specified, e.g. might receive duplicate records, incomplete records, partially overwritten records, etc.

The termCodeparameter should map to a value in v_external_faculty_course_roster.term_code.

...