Version 1 Resources

Return to Web API

Evaluation Search

Overview

The Evaluation Search resource returns a collection of evaluation items and the related section and instructor items that they cover.

URI

/evaluation

Query parameters:

• year (required)
• term_name (required)
• curriculum_abbreviation
• course_number
• section_id
• student_id – the institution’s local identifier for a student
• instructor_id – the institution’s local identifier for an instructor

These query parameters are also described in a Collection+JSON query object in the collection.queries array.  It is labelled with a prompt attribute of “Evaluation Search Resource”.

Items and Attributes

This resource returns evaluation, section, and instructor items.  The data objects of each item are described below.

Evaluation Item

• href – the API URI used to retrieve a representation of the associated evaluation
• links
  • Evaluation URL – the web application URL for completing a course evaluation; rel=”publishedto”
  • Course Summary Report URL – the URL instructors use to view their course evaluation report; rel=”report”
• data
  • id – IASystem unique identifier for an evaluation
  • year
  • termName
  • deliveryMethod
  • status
  • responseRate
  • openDate
  • closeDate
  • reportAvailableDate

Section Item

• data
  • instCourseId
  • year
  • termName
  • curriculumAbbreviation
  • courseNumber
  • sectionId
  • courseTitle

Instructor Item

• data
  • instInstructorId
  • firstName
  • lastName

Evaluation Completion Item

• data
  • evaluationId
  • studentId
  • isCompleted

Error Messages

Evaluation

Overview

The Evaluation resource returns a representation of an IASystem course evaluation.  The collection will include an evaluation item along with the related section and instructor items that it covers.

URI

/evaluation/{id}

Items and Attributes

This resource returns items of type evaluation, section, and instructor.  See the Evaluation Search resource for their descriptions.

Error Messages