Pearson
Always Learning

This API allows you to retrieve, create, update, and delete entries in the course webliography. All users enrolled in a course can use all functions of this API.



Supported Roles and Authentication Protocols

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

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/webliographyEntries{.format}
  • Retrieves all the entries in a course.
GET /courses/{courseId}/webliographyEntries/{entryId}{.format}
  • Retrieve a single entry.
POST /courses/{courseId}/webliographyEntries{.format}
  • Create an entry.
PUT /courses/{courseId}/webliographyEntries/{entryId}{.format}
  • Update an entry.
DELETE /courses/{courseId}/webliographyEntries/{entryId}{.format}
  • Delete an entry.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID. This API does not support overloads. Numeric ID issued by LearningStudio
{entryId} LearningStudio Webliography Entry ID. Numeric ID issued by LearningStudio
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Query String Parameters

Query Parameter Name Description Valid Values
v Version 2 of this API includes the siteEditedDate parameters, which details the date and time the site noted in the webliography was last edited (if known). 2 or Blank

Request Body

For GET and DELETE Requests

None.

For POST Requests

{
  "webliographyEntry":{
    "title":"{webliographyEntryTitle}",
    "description":"{webliographyEntryDescription}",
    "site":{
      "url":"{siteURL}"
    },
    "submitter":{
      "userId":{userId}
    },
    "category":{
	  "id":{categoryId}
	}
  }
}

For PUT Requests

{
  "webliographyEntry":{
    "id":{webliographyEntryId},
    "title":"{webliographyEntryTitle}",
    "description":"{webliographyEntryDescription}",
    "site":{
      "url":"{siteURL}"
    },
    "submitter":{
      "userId":{userId}
    },
    "category":{
	  "id":{categoryId}
	}
  }
}

Property Descriptions

Name Description Valid Values
{webliographyEntryId} Id of the webliography entry. Numeric ID issued by LearningStudio
{webliographyEntryTitle} Title of the webliography entry. Any string of text
{webliographyEntryDescription} User's annotation for the website being saved. Any string of text
{siteURL} Web address (URL) for the entry, including http://. Valid URL
{userId} LearningStudio User Id of the user who is submitting the webliography entry. Should match the user for the OAuth 2 Access Token being used. Numeric ID issued by LearningStudio
{categoryId} LearningStudio Webliography Category Id to assign to the entry. Numeric ID issued by LearningStudio

API Response

Response Headers

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

Note: When creating a grade, the API will return a Location header, providing the location of the new grade object. See this page for more about this header.

Response Body

Format

{
  "webliographyEntries":[
  {
    "id":{webliographyEntryId},
    "title":"{webliographyEntryTitle}",
    "description":"{webliographyEntryDescription}",
    "category":{
      "id":{webliographyCategoryId},
      "name":"{webliographyCategoryName}"
    },
    "site":{
      "url":"{siteURL}",
      "author":"{siteAuthor}",
      "lastEditedDate":"{lastEditedDate}"
	  "siteEditedDate":"{siteEditedDate}"
    },
    "submitter":{
      "userId":{userId},
      "firstName":"{firstName}",
      "lastName":"{lastName}"
    }
  }]
}

Property Descriptions

Name Description
{webliographyEntryId} ID of the webliography entry.
{webliographyEntryTitle} Title of the webliography entry.
{webliographyEntryDescription} Description user added for the webliography entry.
{webliographyCategoryId} ID of the webliography category.
{webliographyCategoryName} Name of the webliography category.
{siteURL} Web address (URL) for the entry.
{siteAuthor} Name or the author or creator of the site.
{lastEditedDate} Date and time the entry was last edited.
{siteEditedDate} Date and time the web site that makes up the entry was last edited (if known). Only returned in Version 2 of the API.
{userId} LearningStudio user Id of the user who submitted the webliography entry.
{firstName} First name of the user.
{lastName} Last name of the user.

Example: Get All Entries

Request

Endpoint

GET /courses/888888/webliographyEntries

Response

Body

{
  "webliographyEntries":[
  {
    "id":525714,
    "title":"Google Search",
    "description":"THE search engine.",
    "category":{
      "id":190657,
      "name":"Search Engines"
    },
    "site":{
      "url":"http://www.google.com/",
      "author":"Google, Inc.",
      "lastEditedDate":"2011-01-03T07:00:00Z"
    },
    "submitter":{
      "userId":2116922,
      "firstName":"joe",
      "lastName":"student"
    }
  },
  {
    "id":525715,
    "title":"Pearson eCollege",
    "description":"The best solution for online education.",
    "category":{
      "id":190659,
      "name":"Education"
    },
    "site":{
      "url":"http://www.ecollege.com/index.learn",
      "author":"Pearson, Inc.",
      "lastEditedDate":"2011-01-11T010:00:00Z"
    },
    "submitter":{
      "userId":2116923,
      "firstName":"joe",
      "lastName":"professor"
    }
  }
  ]
}

Example: Create Webliography Entry

Request

Endpoint

POST /courses/888888/webliographyEntries

Body

{
  "webliographyEntry":{
    "title":"My Nifty Website",
    "description":"A website full of nifty and interesting content.",
    "site":{
      "url":"http://www.someniftysite.com/"
    },
    "submitter":{
      "userId":2116923
    },
    "category":{
	  "id":808080
	}
  }
}

Response

HTTP Status Code

201 Created

HTTP Headers

Location: https://api.learningstudio.com/courses/888888/webliographyEntries/555555
2672 reads
Always Learning
Pearson