Pearson
Always Learning

This API returns the list of available categories in the course that the user has access to. If the category belongs to a group, then there is additional information about that group.



Supported Roles and Authentication Protocols

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

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/docSharingCategories{.format}
  • Retrieves all Doc Sharing categories for the course that the user (identified by OAuth 2 token) has access to.
GET /courses/{courseId}/docSharingCategories/{categoryId}{.format}
  • Returns a specific Doc Sharing category in the course, selected by ID.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID. Numeric ID issued by LearningStudio. Note this API does not support course overloads.
{categoryId} LearningStudio Doc Sharing Category ID.
  • Numeric ID issued by LearningStudio
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Query Parameters

No Query String Parameters are supported.

Request Body

None

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.

Response Body

Format

{
  docSharingCategories: [{
    "id":  "{categoryId}",
    "title": "{categoryTitle}",
    "assignedGroup": {
      "id": "{groupId}",
      "title": "{groupTitle}"
    }
  },{
    "id":  "{categoryId}",
    "title": "{categoryTitle}"
  }]
}

Property Descriptions

Name Description
{categoryId} LearningStudio ID for the Doc Sharing Category.
{categoryTitle} Category Title.
assignedGroup If the category has been assigned (and is restricted to) a group, this property will be included and contain the identifiers for that group.

Important: if there is no assigned group (meaning all students in the course can access the category), this property will not exist.

{groupId} LearningStudio ID of the assigned group
{groupTitle} Group name of the assigned group.

Note: If you are requesting a single category (see Endpoints, above), the format is the same but there is only one item in the docSharingCategories array.

Example

Request

Endpoint

GET /courses/123456/docsharingcategories

Response

Body

{
  "docSharingCategories": [{
    "id": 123456,
    "title": "Category 1",
    "assignedGroup": {
      "id": 4554,
      "title": "Group A"
    }
  },
  {
    "id": 987641,
    "title": "Category 2"
  }]
}
1282 reads
Always Learning
Pearson