Course Offering

Create Course Offering

Creates a new course offering (e.g., semester, term, or academic period) under the specified application install.<br/><br/>The matchStrings field is used to automatically match incoming courses from the LMS to this offering based on text patterns.

post/v1/installs/{installSid}/courseOfferings

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/courseOfferings
  • Auth
    API key in header token

Path parameters

installSidstring required

Unique SID of the application install. Pattern: AI + 32 hex chars.

Example:AI1234567890abcdef1234567890abcdef

Request body

titlestring required

Human-readable title for the course offering (e.g., semester or term name).

matchStringsstring required

Comma-separated list of text patterns used to automatically match incoming LMS courses to this offering.

startDatestring nullable

Start Date

endDatestring nullable

End Date

Example request

{
  "title": "Fall 2024",
  "matchStrings": "Fall 2024,FA24",
  "startDate": "1970-01-01T00:00:00.000Z",
  "endDate": "1970-01-01T00:00:00.000Z"
}

Response

Successful

sidstring nullable

Course offering SID

lastActivityDatestring nullable

Last activity date

titlestring nullable

Offering title

matchStringsstring[] nullable

Match strings for auto-matching

startDatestring nullable

Start date

endDatestring nullable

End date

createdDatestring nullable

Created date

editDatestring nullable

Last modified date

Changes

No recorded changes to this operation across all 13 revisions of this API.