GET v4/courses - Read

The courses API group allows you to retrieve the LMS course(s) data for a particular school. This course data can enable a school's bookstore to better manage the school's digital course materials program when the school is utilizing the VitalSource LTI tool to access their digital materials.

Verb/URI
Data Definitions
Request Headers
Response
- Response Body
- Successful Response Code and Message
Error Codes

This endpoint allows you to retrieve all courses for a particular school, or courses that have been created or updated in a given time period.

Verb/URI

GET https://launch.vitalsource.com/api/v4/courses

Data Definitions

Name	Usage	Description	Data Type	Example	Required
page	URL param / Message body	page number of course request, default to page 1	integer	/courses?page=1	No
per_page	URL param / Message body	number of courses returned per request, default is 100	integer 1-1000	/courses?per_page=1000	No
created_from	URL param	returns courses that have been created at or since this time	ISO-8601 date/time	/courses?created_from=2019-06-07T20:25:22Z	No
created_until	URL param	returns courses that have been created at or since this time	ISO-8601 date/time	/courses?created_until=2019-06-11T20:25:22Z	No
updated_from	URL param	returns courses that have been updated at or since this time	ISO-8601 date/time	/courses?updated_from=2019-06-07T20:25:22Z	No
updated_until	URL param	returns courses that have been updated at or until this time	ISO-8601 date/time	/courses?updated_until=2019-06-11T20:25:22Z	No
id	Message Body	VitalSource identifier for the course	integer	12345678910	N/A
tenant_id	Message Body	VitalSource identifier for the school	integer	12345678910	N/A
term_id	Message Body	VitalSource identifier for the term the course is a part of. Terms are not always used, this will vary by LMS.	integer	12345678910	N/A
name	Message Body	VitalSource name for the course, often sourced from the LTI context_id	String	eou1e5vbkw0ag2j3xyc8	N/A
title	Message Body	LMS course title / LTI context_title, may not be unique per course	String	English 101 - Introduction to English Literature	N/A
label	Message Body	LMS course label / LTI context_label, may not be unique per course	String	FA2019-ENGL-101-001	N/A
lms_context_id	Message Body	LTI context_id, unique per course	String	01fmc37hw81p4hq3u8jl	N/A
sis_id	Message Body	SIS course identifier	String	FA2019ENGL101001123456	N/A
lms_course_id	Message Body	Course identifier specific to the LMS platform, may vary by LMS	String	a3op0bfsci5hfzzg6nko	N/A
start_date	Message Body	Course start date	Date	YYYY-MM-DD	N/A
end_date	Message Body	Course end date	Date	YYYY-MM-DD	N/A
census_date	Message Body	Date marking the end of the add/drop period, used for determining when add/drop licenses should be issued	Date	YYYY-MM-DD	N/A
opt_out_date	Message Body	Date marking the end of the add/drop period, used for determining when the opt in/opt out toggle should be available to students in the Launch UI	Date	YYYY-MM-DD	N/A
active	URL param / Message body	Used to indicate if a course is active or not. Courses become inactive after the end_date has passed. If no end_date is available, courses become inactive 45 days after the last student LTI launch from the course	Boolean	true	No
created_at	Message Body	The date the course was created in the VitalSource system	ISO-8601 date/time	2018-12-04T15:59:59Z	N/A
updated_at	Message Body	The date the course was last updated in the VitalSource system	ISO-8601 date/time	2018-12-04T15:59:59Z	N/A

Request Headers

X-VitalSource-API-Key: ABCDEFGHIJKLMNOP
Accept: application/json
Content-type: application/json

Response

Response Body

JSON

{
  "page": 1,
  "per_page": 100,
  "num_items": 2,
  "total_pages": 1,
  "courses": [
    {
      "id": 5260876,
      "tenant_id": 1023,
      "term_id": 100349,
      "name": "Tarot Card Reading I",
      "title": "Tarot Card Reading I",
      "label": "jn_053216_109912",
      "lms_context_id": "18342",
      "sis_id": "001443282",
      "lms_course_id": "006b38dc4706c247a3318acef171ef9b1d985f7713a",
      "start_date": "2016-08-24",
      "end_date": "2016-12-05",
      "census_date": "2016-09-05",
      "out_out_date": "2016-09-04",
      "active": true,
      "created_at": "2018-12-04T15:59:59Z",
      "updated_at": "2018-12-04T15:59:59Z"
    },
    {
      "id": 5260877,
      "tenant_id": 1023,
      "term_id": 100349,
      "name": "Homeopathy II",
      "title": "Homeopathy II",
      "label": "jn_053216_109935",
      "lms_context_id": "18343",
      "sis_id": "001443287",
      "lms_course_id": "006b38dc4706c247a3318acef923ef9b1d985f7713a",
      "start_date": "2016-08-24",
      "end_date": "2016-12-05",
      "census_date": "2016-09-05",
      "out_out_date": "2016-09-04",
      "active": true,
      "created_at": "2018-12-04T15:59:59Z",
      "updated_at": "2018-12-04T15:59:59Z"
    }
  ]
}

Successful Response Code and Message

HTTP: 200 OK

Error Codes

HTTP Status	Message	Notes
401	Unauthorized	The API key provided is not associated with any LTI integration
404	Not Found