Pearson
Always Learning

This API allows you retrieve and update the gradebook review dates for exams in a course.

Note: The IDs used in this API are the content item IDs for the content item containing the exam, not the exam ID. (Course scheduling is attached to the content item structure.)



Supported Roles and Authentication Protocols

Type Supported Values
Authentication Protocols OAuth 1.0a, OAuth 2.0
Valid for Roles (OAuth 2): Professor, Teaching Assistant, Administrator

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/examschedules{.format}
  • Retrieves an array of all exam content items in the course with their gradebook review date.
GET /courses/{courseId}/examschedules/{contentItemId}{.format}
  • Retrieves a single exam content item.
PUT /courses/{courseId}/examschedules{.format}
  • Update gradebook review dates for all exam content items in the course.
  • Important: When updating exam schedules, you must update all the exams at once even if you're only changing a single date.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}
{contentItemId} LearningStudio Content Item ID. Numeric ID issued by LearningStudio
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Query String Parameters

No Query String Parameters are supported.

Request Body

For GET Requests

None.

For PUT Requests

{
  "examSchedules": [{
    "itemId": {contentItemId},
    "itemTitle": "{itemTitle}",
    "schedule": {
      "gradebookReviewDate": "{reviewDateTime}"
      }
  },{
    "itemId": {contentItemId},
    "itemTitle": "{itemTitle}",
    "schedule": {
      "gradebookReviewDate": "{reviewDateTime}"
      }
  }]
}

Property Descriptions

Name Description Valid Values
{contentItemId} Content Item ID of the exam item.
{itemTitle} Title of the exam item. Note: This property is ignored on PUTs. Changes are not saved, and you can also exclude the itemTitle property altogether.
{reviewDateTime} Timestamp of the new gradebook review date. Date must be in ISO-8601 format, e.g. YYYY-MM-DDTHH:MM:SSZ

API Response

Response Header

This API returns the standard HTTP Status Codes used by the LearningStudio APIs. There are no special headers returned by the API.

When updating schedules, the API will return a status code of 204 - No Content and no payload.

Response Body

{
  "examSchedules": [{
    "itemId": {contentItemId},
    "itemTitle": "{itemTitle}",
    "schedule": {
      "gradebookReviewDate": "{reviewDateTime}"
    }
  },{
    "itemId": {contentItemId},
    "itemTitle": "{itemTitle}",
    "schedule": {
      "gradebookReviewDate": "{reviewDateTime}"
    }
  }]
}

Note: If requesting a single exam schedule (see Endpoints, above), the top-level property will be named examSchedule and its value will be an object instead of an array.

Property Descriptions

Name Description
{contentItemId} The LearningStudio Content Item ID containing the exam.
{itemTitle} Title of the exam item.
{reviewDateTime} Gradebook review date, in ISO-8601 format.

Example: Get Exam Schedules

Request

Endpoint

GET /courses/123456/examschedules

Response

Body

{
  "examSchedules": [{
    "itemId": 100123456,
    "itemTitle": "Exam 1",
    "schedule": {
      "gradebookReviewDate": "2012-03-10T17:58:00Z"
    }
  }, {
    "itemId": 100234567,
    "itemTitle": "Exam 2",
    "schedule": {
      "gradebookReviewDate": "2011-03-17T08:58:00Z"
    }
  }, {
    "itemId": 100345678,
    "itemTitle": "Exam 3",
    "schedule": {
      "gradebookReviewDate": "2011-03-24T10:58:00Z"
    }
  }]
}

Example: Update Exam Schedules

Request

Endpoint

 
PUT /courses/123456/examschedules

Body

{
  "examSchedules": [{
    "itemId": 100123456,
    "itemTitle": "Exam 1",
    "schedule": {
      "gradebookReviewDate": "2012-04-01T17:58:00Z"
    }
  }, {
    "itemId": 100234567,
    "itemTitle": "Exam 2",
    "schedule": {
      "gradebookReviewDate": "2011-04-01T08:58:00Z"
    }
  }, {
    "itemId": 100345678,
    "itemTitle": "Exam 3",
    "schedule": {
      "gradebookReviewDate": "2011-04-01T10:58:00Z"
    }
  }]
}

Response

HTTP Status Code

204 No Content
4140 reads
Always Learning
Pearson