...
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/{idfacultySchoolId}/instruction/course
Security
PERSON_INSTRUCTION_READ
Returns
List<ExternalCourseTO>
| Code Block |
|---|
{"success" : "true",
message: "results",
results: "100"2,
"rows" :
[{facultySchoolId: "createdBycoach001",
: {"id" termCode: "91f46e39-cea8-422b-b215-00f6bcf5d280FA12",
"firstName" formattedCourse: "JohnDEV-MTH-101",
title: "lastName" : "DoeRemedial Algebra"},
"createdDate" {facultySchoolId: "1332216000000coach001",
"description" termCode: "International.FA12",
"id" formattedCourse: "6201b18dDEV-9d1d-48d3-82d4-092e52ad676bENG-101",
title: "Remedial Written Composition"modifiedBy"}
:
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Earn a 2.0 Fall Term",
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}
},
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"description" : "Graduate",
"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Graduate",
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}
},
...
]
} |
Get the Course Roster for a Course I'm Instructing
GET /ssp/api/1/person/{id}/instruction/course/{id}/roster
Returns
List<Person>
| Code Block |
|---|
{"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Naturalized Citizen.", "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "name" : "Earn a 2.0 Fall Term", "confidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"} ] } |
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>
| 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. |
| Code Block |
|---|
{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"}
]
} |