Get Started with the Attendance API

Document created by rh0068002 on Jan 11, 2019
Version 1Show Document
  • View in full screen mode

Overview

The Attendance API is a REST API that works in conjunction with Blackboard Learn. It becomes available in Blackboard Learn with release 3500.7. You use the Attendance API to track user attendance at meetings. In the context of a course, a "meeting" is a class session. You can also use the Attendance API in conjunction with organizations. Because the Attendance API is part of the broader set of Learn APIs, if you haven't worked with Blackboard Learn's REST APIs before, first see Getting Started With REST.

 

Use the Attendance API

The main things you can do with the Attendance API are: create and manage meetings, create and manage attendance records, and retrieve attendance reports.

 

Create and Manage Meetings

In the context of a course, a "meeting" is a class session. You can also use the Attendance API in conjunction with organizations. To do so, use the organization's ID where the course ID is required. Course and organization IDs never conflict, and organizations are functionally almost identical to courses so this approach works well.

 

  • Create a meeting: POST to /learn/api/public/v1/courses/{courseId}/meetings. You will include the id of the course or organization in the body of the request. You can get a list of meetings for a course or organization by requesting a GET to the same URL. Warning: if you DELETE to this URL (/learn/api/public/v1/courses/{courseId}/meetings), you will delete all meetings from the course or organization.
  • Get the description of a particular meeting for a particular course or organization: GET to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}.
  • Update or correct the settings for a meeting: PATCH to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}.
  • Delete all meetings for a course or organization: DELETE to /learn/api/public/v1/courses/{courseId}/meetings.
  • Delete a single meeting record: DELETE to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}.

Create and Manage Attendance Records

Once you have created a meeting, you can create and manage attendance records for it.

  • Create an attendance record: POST to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users. You will include the userId in the body of the request. Warning: if you DELETE to this URL (/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users), you will delete all attendance records for the meeting.
  • Update or correct an attendance record: PATCH to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId}.
  • Delete all attendance records for a meeting: DELETE to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users.
  • Delete a single user's attendance record for a meeting by requesting a DELETE to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId}.

Retrieve Attendance RecordsYou can use the Attendance API to retrieve information about attendance.

  • Get a download link for all attendance data for a course or org, GET to /learn/api/public/v1/courses/{courseId}/meetings/downloadUrl.
  • Get a list of meetings scheduled for a course or organization, GET to /learn/api/public/v1/courses/{courseId}/meetings.
  • Get a user's complete attendance record, GET to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId}.
  • Get the complete attendance record for a course, GET to /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users.
  • Get a user's attendance for all meetings regards regardless of course or organization, GET to /learn/api/public/v1/courses/{courseId}/meetings/users/{userId}.

API Reference DocumentationYou can consult the reference documentation at https://app.swaggerhub.com/apis/BBDN/attendance/.

More Information

Attachments

    Outcomes