Instruction API

Overview

Methods for returning information about courses the person is an instructor of. These APIs are called from the EA portlet.

Get All Courses by Instructor, Term and Course

Returns all courses that the person is teaching for the current term.

GET /ssp/api/1/person/{facultySchoolId}/instruction/course

Security

PERSON_INSTRUCTION_READ

Returns

List<ExternalCourseTO>

{success: "true",
message: "",
results: 2,
rows: 
	[{facultySchoolId: "coach001",
	  termCode: "FA12",
	  formattedCourse: "DEV-MTH-101",
	  title: "Remedial Algebra"},
	 {facultySchoolId: "coach001",
	  termCode: "FA12",
	  formattedCourse: "DEV-ENG-101",
	  title: "Remedial Written Composition"}
	]
}

Get the Course Roster by Course

Returns all students on the specified course for the current term.

GET /ssp/api/1/person/{facultySchoolId}/instruction/course/{formattedCourse}/roster

Security

PERSON_INSTRUCTION_READ

Returns

List<ExternalFacultyCourseRosterTO>

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.

{success: "true",
message: "",
results: 3,
rows: 
	[{schoolId: "omoore",
	  firstName: "Oliver",
	  middleName: null,
	  lastName: "Moore",
	  facultySchoolId: "coach001",
	  formattedCourse: "DEV-MTH-101",
	  primaryEmailAddress: "omoore@unicon.net",
	  statusCode: null,
	  termCode: "FA12"},
	 {schoolId: "owilburn",
	  firstName: "Oliver",
	  middleName: null,
	  lastName: "Wilburn",
	  facultySchoolId: "coach001",
	  formattedCourse: "DEV-MTH-101",
	  primaryEmailAddress: "owilburn@unicon.net",
	  statusCode: null,
	  termCode: "FA12"},
	 {schoolId: "sgomes",
	  firstName: "Shawn",
	  middleName: null,
	  lastName: "Gomes",
	  facultySchoolId: "coach001",
	  formattedCourse: "DEV-MTH-101",
	  primaryEmailAddress: "sgomes@unicon.net",
	  statusCode: null,
	  termCode: "FA12"}
	]
}