Skip to content

Commit

Permalink
Merge pull request #131 from blackboard/390098assignmentchanges
Browse files Browse the repository at this point in the history
Change documentation to account for the fact that an assignment can no longer have questions like a test
  • Loading branch information
mark-b-kauffman authored Nov 1, 2024
2 parents e610236 + ed54554 commit 6849d2b
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 36 deletions.
14 changes: 14 additions & 0 deletions blog/2024/2024-11-01-changes-to-assignments-blackboard-3900.98.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
slug: changes-to-assignments-blackboard-3900.98
title: Changes to Assignments With Blackboard 3900.98
published: "2024-11-01"
edited: "2024-11-01"
author: Mark Kauffman
tags: ['Assignments', 'Tests', 'Integrations', 'Partners', 'Developers', 'Community']
hide_table_of_contents: false
---
<VersioningTracker frontMatter={frontMatter}/>

We are writing this blog post to document a change to how REST APIs work with Ultra Assignments and Tests. Previously, before Blackboard version 3900.98, you could use the createAssignment REST API and treat the resulting object like a Test. You could add more than one question of differing types, using the user interface. You could use the REST API and add more than one presentation-type question type using POST request to /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions/{questionId}.

[Blackboard introduced a new Assignment tool with version 3900.98.](https://help.blackboard.com/Learn/Administrator/SaaS/Release_Notes/Archived_Release_Notes#3900.98.0-6) It is no longer the same as a Test. With the new Assignment tool, when you use createAssignment the assignment body is still created, but you only see the instructions, with no option to add questions, and you cannot add questions using the assessments endpoint. To create a Test you must now use the createContent endpoint. You can find more information here: [Creating and Updating Content with REST APIs](/docs/blackboard/rest-apis/hands-on/creating-content-with-rest-apis).
41 changes: 6 additions & 35 deletions docs/blackboard/rest-apis/advanced/[review]ultra-assignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,13 @@ author: Ryan Haber

### Overview

Learn Ultra experience offers a REST API for managing assessments.
In Ultra, an assessment is effectively the same thing as an assignment except
for how they are stored internally. In an assessment, there are questions of
various types. Each 'question' is a slot for content that may not actually
contain what you normally think of as a question. For more information about
assignments and questions and how Learn users experience them, see [Ultra:
Blackboard Ultra experience offers a REST API for managing assignments.
As of Blackbord 3900.98, in Ultra, an assignment is different from a test. SEE [Changes to Assignments With Blackboard 3900.98](/blog/changes-to-assignments-blackboard-3900.98) In an test, there are questions of various types. For an assignment, which we are disucssing
here, there is only a leading set of instructions. For more information about
assignments how Learn users experience them, see [Ultra:
Create an Assignment](https://help.blackboard.com/learn/Instructor/Ultra/Assignments/Create_and_Edit_Assignments) in Blackboard Help.

An assignment is made up of one or more questions. The following question
types are available for use with Ultra via REST API.

- `EitherOr` - questions that allow one of two possible responses, such as "true or false"
- `Essay` - questions that provide a WYSIWYG editor and allow long text response
- `MultipleAnswer` - allow students to choose more than one answer
- `Presentation` - represents a 'question' that only has text and/or attached files referenced from within question.text, but that has no actual answer, points, or evaluation associated with it

As of version 3300.9.0, you can use the public API to read any type of
question. You can use the public API to create, update, and delete methods
only with presentation-type questions.
Prior to 3900.98 you could add questions to an assignment. This is no longer the case.

### Before You Begin

Expand All @@ -53,27 +41,10 @@ to Learn.
1. Make a POST request to /learn/api/public/v1/uploads.
2. Use the ID number in the response to further access the uploaded file.

### Add Content to an Existing Assignment

As of 3300.9.0 you can add only presentation-type "questions" to assignments
using the public REST API.

1. Make a POST request to /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions/{questionId}

2. You can validate the response body against your original response body.

### Assignment-related Query Parameters

All endpoints accept a query parameter fields that specifies the fields to be
All endpoints accept a query parameter, fields, that specifies the fields to be
included in the response object, if any. The fields to be included are given
as a comma-separated list. Specified fields are ignored if absent from the
response. If no fields are specified, all fields are returned in the response.
For example:

POST to /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/que
stions/{questionId}?fields=id,title,status,message

returns the ID and title of questions if the request succeeds because only
those fields are included in the success response object. The method returns
status and message if the request fails because only those fields are included
in the error response object.
2 changes: 1 addition & 1 deletion docs/blackboard/rest-apis/hands-on/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ Returns when 200:

## Creating Children content

Please review the types of content you can create based on the contentHandler, please review: https://docs.anthology.com/rest-apis/learn/advanced/contenthandler-datatypes
Please review the types of content you can create based on the contentHandler, please review: https://docs.anthology.com/docs/blackboard/rest-apis/advanced/content-handler

### Creating a folder within a folder

Expand Down

0 comments on commit 6849d2b

Please sign in to comment.