UNPKG

@markkauffman/bbrest

Version:

Make all REST API calls to Blackboard Learn Server. Based off similar work by Matthew Deakyne for Python.

740 lines 365 kB
7 PATH /learn/api/public/v1/oauth2/authorizationcode DESCRIPTION VERSIONS 3200.7.0 PATH /learn/api/public/v1/oauth2/token DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/oauth2/tokeninfo DESCRIPTION VERSIONS 3700.6.0 PATH /learn/api/public/v1/announcements DESCRIPTION VERSIONS 3100.7.0 PATH /learn/api/public/v1/announcements DESCRIPTION VERSIONS 3100.7.0 PATH /learn/api/public/v1/announcements/{announcementId} DESCRIPTION VERSIONS 3100.7.0 PATH /learn/api/public/v1/announcements/{announcementId} DESCRIPTION VERSIONS 3100.7.0 PATH /learn/api/public/v1/announcements/{announcementId} DESCRIPTION VERSIONS 3100.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/downloadUrl DESCRIPTION VERSIONS PATH /learn/api/public/v1/courses/{courseId}/meetings/users/{userId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/users/{userId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/users/{userId}/all DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/bulk DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId} DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/calendars DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/calendars/items DESCRIPTION VERSIONS 2018-01-01,00:00:00,2018-02-01,00:00:00,2018-01-01,00:00:00,2018-02-01,00:00:00,123_1,2018-01-01,00:00:00,2018-02-01,00:00:00,123_1,2018-01-01,00:00:00,2018-02-01,00:00:00,123_1,2018-01-01,00:00:00,2018-02-01,00:00:00,2018-01-01,00:00:00,2018-02-01,00:00:00,3400.9.0 PATH /learn/api/public/v1/calendars/items DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/calendars/items/{calendarItemType}/{calendarItemId} DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/calendars/items/{calendarItemType}/{calendarItemId} DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/calendars/items/{calendarItemType}/{calendarItemId} DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/courses/{courseId}/contents DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/contents DESCRIPTION VERSIONS 3000.7.0 PATH /learn/api/public/v1/courses/{courseId}/contents/createAssignment DESCRIPTION VERSIONS 3300.9.0,3400.9.0,3300.9.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId} DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId} DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId} DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/children DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/children DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/attachments DESCRIPTION VERSIONS 3400.9.0,3200.8.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/attachments DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/attachments/{attachmentId} DESCRIPTION VERSIONS 3400.9.0,3200.8.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/attachments/{attachmentId} DESCRIPTION VERSIONS 3400.9.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/attachments/{attachmentId}/download DESCRIPTION VERSIONS 3400.9.0,3200.8.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/groups DESCRIPTION VERSIONS 3100.5.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/groups/{groupId} DESCRIPTION VERSIONS 3100.5.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/groups/{groupId} DESCRIPTION VERSIONS 3100.5.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/groups/{groupId} DESCRIPTION VERSIONS 3100.5.0 PATH /learn/api/public/v1/courses/{courseId}/resources DESCRIPTION VERSIONS 3700.12.0 PATH /learn/api/public/v1/courses/{courseId}/resources/{resourceId} DESCRIPTION VERSIONS 3700.13.0 PATH /learn/api/public/v1/courses/{courseId}/resources/{resourceId}/children DESCRIPTION VERSIONS 3700.13.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/users/{userId}/reviewStatus DESCRIPTION VERSIONS 3700.16.0 PATH /learn/api/public/v1/courses/{courseId}/contents/{contentId}/users/{userId}/reviewStatus DESCRIPTION VERSIONS 3700.16.0 PATH /learn/api/public/v1/courses/{courseId}/announcements DESCRIPTION VERSIONS 3500.3.0 PATH /learn/api/public/v1/courses/{courseId}/announcements DESCRIPTION VERSIONS 3500.3.0 PATH /learn/api/public/v1/courses/{courseId}/announcements/{announcementId} DESCRIPTION VERSIONS 3500.3.0 PATH /learn/api/public/v1/courses/{courseId}/announcements/{announcementId} DESCRIPTION VERSIONS 3500.3.0 PATH /learn/api/public/v1/courses/{courseId}/announcements/{announcementId} DESCRIPTION VERSIONS 3500.3.0 PATH /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions DESCRIPTION VERSIONS 3300.9.0 PATH /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions DESCRIPTION VERSIONS 3300.9.0 PATH /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions/{questionId} DESCRIPTION VERSIONS 3300.9.0 PATH /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions/{questionId} DESCRIPTION VERSIONS 3300.9.0 PATH /learn/api/public/v1/courses/{courseId}/assessments/{assessmentId}/questions/{questionId} DESCRIPTION VERSIONS 3300.9.0 PATH /learn/api/public/v1/catalog/categories/{categoryType} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{categoryId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{categoryId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{categoryId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{categoryId}/courses DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{categoryId}/courses/{courseId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{categoryId}/courses/{courseId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/catalog/categories/{categoryType}/{parentId}/children DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/courses/{courseId}/categories DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/attempts/{attemptId}/files DESCRIPTION VERSIONS 3400.6.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/attempts/{attemptId}/files DESCRIPTION VERSIONS 3500.7.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/attempts/{attemptId}/files/{attemptFileId} DESCRIPTION VERSIONS 3400.6.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/attempts/{attemptId}/files/{attemptFileId} DESCRIPTION VERSIONS 3500.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/attempts/{attemptId}/files/{attemptFileId}/download DESCRIPTION VERSIONS 3400.6.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/gradeNotations DESCRIPTION VERSIONS 3200.13.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/gradeNotations DESCRIPTION VERSIONS 3200.13.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/gradeNotations/{gradeNotationId} DESCRIPTION VERSIONS 3200.13.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/gradeNotations/{gradeNotationId} DESCRIPTION VERSIONS 3200.13.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/gradeNotations/{gradeNotationId} DESCRIPTION VERSIONS 3200.14.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/categories DESCRIPTION VERSIONS 3400.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/categories/{categoryId} DESCRIPTION VERSIONS 3400.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/schemas DESCRIPTION VERSIONS 3300.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/schemas DESCRIPTION VERSIONS 3300.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/schemas/{schemaId} DESCRIPTION VERSIONS 3300.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/schemas/{schemaId} DESCRIPTION VERSIONS 3300.2.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/schemas/{schemaId} DESCRIPTION VERSIONS 3300.2.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns DESCRIPTION VERSIONS 3200.10.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns DESCRIPTION VERSIONS 3200.10.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId} DESCRIPTION VERSIONS 3200.10.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId} DESCRIPTION VERSIONS 3200.10.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId} DESCRIPTION VERSIONS 3200.10.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/attempts DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/attempts DESCRIPTION VERSIONS 3300.12.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/attempts/{attemptId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/attempts/{attemptId} DESCRIPTION VERSIONS 3500.2.0,3300.12.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/users DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/users/lastChanged DESCRIPTION VERSIONS 3300.4.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/users/{userId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/users/{userId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v2/courses/{courseId}/gradebook/users/{userId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/periods DESCRIPTION VERSIONS 3300.3.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/periods DESCRIPTION VERSIONS 3300.3.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/periods/{periodId} DESCRIPTION VERSIONS 3300.3.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/periods/{periodId} DESCRIPTION VERSIONS 3300.3.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/periods/{periodId} DESCRIPTION VERSIONS 3300.3.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId}/users DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId}/users/{userId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId}/users/{userId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId}/users/{userId} DESCRIPTION VERSIONS 3600.0.0 PATH /learn/api/public/v2/courses/{courseId}/groups DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets/{groupId} DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets/{groupId} DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets/{groupId} DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets/{groupId}/groups DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/sets/{groupId}/groups DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId} DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId} DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v2/courses/{courseId}/groups/{groupId} DESCRIPTION VERSIONS 3800.6.0 PATH /learn/api/public/v1/courses/{courseId}/users DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/courses/{courseId}/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/courses/{courseId}/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/courses/{courseId}/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/courses/{courseId}/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/users/{userId}/courses DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/courses/{courseId}/messages DESCRIPTION VERSIONS 3900.2.0 PATH /learn/api/public/v1/courses/{courseId}/messages DESCRIPTION VERSIONS 3900.2.0 PATH /learn/api/public/v1/courses/{courseId}/messages/folders DESCRIPTION VERSIONS 3900.2.0 PATH /learn/api/public/v1/courses/{courseId}/messages/{messageId} DESCRIPTION VERSIONS 3900.2.0 PATH /learn/api/public/v1/courses/{courseId}/messages/{messageId} DESCRIPTION VERSIONS 3900.2.0 PATH /learn/api/public/v1/courses/{courseId}/messages/{messageId}/participants DESCRIPTION VERSIONS 3900.2.0 PATH /learn/api/public/v1/courses/{courseId}/children DESCRIPTION VERSIONS 3000.11.0 PATH /learn/api/public/v1/courses/{courseId}/children/{childCourseId} DESCRIPTION VERSIONS 3000.11.0 PATH /learn/api/public/v1/courses/{courseId}/children/{childCourseId} DESCRIPTION VERSIONS 3400.1.0 PATH /learn/api/public/v1/courses/{courseId}/children/{childCourseId} DESCRIPTION VERSIONS 3900.4.0 PATH /learn/api/public/v1/courses/{courseId}/crossListSet DESCRIPTION VERSIONS 3400.1.0 PATH /learn/api/public/v1/courses/{courseId}/tasks/{taskId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v2/courses/{courseId}/copy DESCRIPTION VERSIONS 3800.2.0 PATH /learn/api/public/v3/courses DESCRIPTION VERSIONS 3800.1.0 PATH /learn/api/public/v3/courses DESCRIPTION VERSIONS 3800.1.0 PATH /learn/api/public/v3/courses/{courseId} DESCRIPTION VERSIONS 3800.1.0 PATH /learn/api/public/v3/courses/{courseId} DESCRIPTION VERSIONS 3800.1.0 PATH /learn/api/public/v3/courses/{courseId} DESCRIPTION VERSIONS 3800.1.0 PATH /learn/api/public/v1/dataSources DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/dataSources DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/dataSources/{dataSourceId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/dataSources/{dataSourceId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/dataSources/{dataSourceId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/courses/{courseId}/nodes DESCRIPTION VERSIONS 3800.10.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes DESCRIPTION VERSIONS 3800.10.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes DESCRIPTION VERSIONS 3800.15.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId} DESCRIPTION VERSIONS 3800.10.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId} DESCRIPTION VERSIONS 3800.15.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId} DESCRIPTION VERSIONS 3800.15.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId}/children DESCRIPTION VERSIONS 3800.10.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId}/children DESCRIPTION VERSIONS 3800.15.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId}/courses DESCRIPTION VERSIONS 3800.10.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId}/courses/{courseId} DESCRIPTION VERSIONS 3800.17.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId}/courses/{courseId} DESCRIPTION VERSIONS 3800.17.0 PATH /learn/api/public/v1/institutionalHierarchy/nodes/{nodeId}/courses/{courseId} DESCRIPTION VERSIONS 3800.17.0 PATH /learn/api/public/v1/lti/placements DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v1/lti/placements DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v1/lti/placements/{placementId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v1/lti/placements/{placementId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/api/public/v1/lti/placements/{placementId} DESCRIPTION VERSIONS 3300.0.0 PATH /learn/apipublic/v1/lti/domains DESCRIPTION VERSIONS 3300.9.0 PATH /learn/apipublic/v1/lti/domains DESCRIPTION VERSIONS 3300.9.0 PATH /learn/apipublic/v1/lti/domains/{domainId} DESCRIPTION VERSIONS 3300.9.0 PATH /learn/apipublic/v1/lti/domains/{domainId} DESCRIPTION VERSIONS 3300.9.0 PATH /learn/apipublic/v1/lti/domains/{domainId} DESCRIPTION VERSIONS 3300.9.0 PATH /learn/api/public/v1/courses/{courseId}/performance/contentReviewStatus DESCRIPTION VERSIONS 3700.15.0 PATH /learn/api/public/v1/proctoring/services DESCRIPTION VERSIONS 3500.6.0 PATH /learn/api/public/v1/proctoring/services/{proctoringServiceId} DESCRIPTION VERSIONS 3500.6.0 PATH /learn/api/public/v1/courseRoles DESCRIPTION VERSIONS 3300.5.0 PATH /learn/api/public/v1/courseRoles/{roleId} DESCRIPTION VERSIONS 3300.5.0 PATH /learn/api/public/v1/institutionRoles DESCRIPTION VERSIONS 3300.4.0 PATH /learn/api/public/v1/institutionRoles/{roleId} DESCRIPTION VERSIONS 3300.4.0 PATH /learn/api/public/v1/systemRoles DESCRIPTION VERSIONS 3300.5.0 PATH /learn/api/public/v1/systemRoles/{roleId} DESCRIPTION VERSIONS 3300.5.0 PATH /learn/api/public/v1/sessions DESCRIPTION VERSIONS 3800.4.0 PATH /learn/api/public/v1/logs/sis/dataSets/{id} DESCRIPTION VERSIONS 3200.0.1 PATH /learn/api/public/v1/system/policies/privacy DESCRIPTION VERSIONS 3400.5.0 PATH /learn/api/public/v1/system/tasks/{taskId} DESCRIPTION VERSIONS 3800.1.0 PATH /learn/api/public/v1/system/version DESCRIPTION VERSIONS 3000.3.0 PATH /learn/api/public/v1/terms DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/terms DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/terms/{termId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/terms/{termId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/terms/{termId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/uploads DESCRIPTION VERSIONS 3100.12.0 PATH /learn/api/public/v1/users DESCRIPTION VERSIONS 3000.1.0 PATH /learn/api/public/v1/users DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/users/{userId} DESCRIPTION VERSIONS 2015.11.0 PATH /learn/api/public/v1/users/{userId}/avatar DESCRIPTION VERSIONS 3800.10.0 PATH /learn/api/public/v1/users/{userId}/observees DESCRIPTION VERSIONS 3500.5.0 PATH /learn/api/public/v1/users/{userId}/observers DESCRIPTION VERSIONS 3500.5.0 PATH /learn/api/public/v1/users/{userId}/observers/{observerId} DESCRIPTION VERSIONS 3500.5.0 PATH /learn/api/public/v1/users/{userId}/observers/{observerId} DESCRIPTION VERSIONS 3500.5.0 PATH /learn/api/public/v1/users/{userId}/sessions DESCRIPTION VERSIONS 3800.4.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns DESCRIPTION VERSIONS 3000.3.0,3200.10.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns DESCRIPTION VERSIONS 3000.7.0,3200.10.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId} DESCRIPTION VERSIONS 3000.3.0,3200.10.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId} DESCRIPTION VERSIONS 3000.7.0,3200.10.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId} DESCRIPTION VERSIONS 3000.7.0,3200.10.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId}/attempts DESCRIPTION VERSIONS 3100.4.0,3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId}/attempts/{attemptId} DESCRIPTION VERSIONS 3100.4.0,3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId}/users DESCRIPTION VERSIONS 3000.3.0,3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId}/users/{userId} DESCRIPTION VERSIONS 3000.3.0,3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/columns/{columnId}/users/{userId} DESCRIPTION VERSIONS 3000.5.0,3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/gradebook/users/{userId} DESCRIPTION VERSIONS 3000.3.0,3300.0.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId}/users DESCRIPTION VERSIONS 3100.6.0,3600.0.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId}/users/{userId} DESCRIPTION VERSIONS 3100.6.0,3600.0.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId}/users/{userId} DESCRIPTION VERSIONS 3100.6.0,3600.0.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId}/users/{userId} DESCRIPTION VERSIONS 3100.6.0,3600.0.0 PATH /learn/api/public/v1/courses/{courseId}/groups DESCRIPTION VERSIONS 3100.5.0,3800.6.0 PATH /learn/api/public/v1/courses/{courseId}/groups DESCRIPTION VERSIONS 3100.5.0,3800.6.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId} DESCRIPTION VERSIONS 3100.5.0,3800.6.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId} DESCRIPTION VERSIONS 3100.5.0,3800.6.0 PATH /learn/api/public/v1/courses/{courseId}/groups/{groupId} DESCRIPTION VERSIONS 3100.5.0,3800.6.0 PATH /learn/api/public/v1/courses DESCRIPTION VERSIONS 3000.1.0,3400.8.0 PATH /learn/api/public/v1/courses DESCRIPTION VERSIONS 2015.11.0,3400.8.0 PATH /learn/api/public/v1/courses/{courseId} DESCRIPTION VERSIONS 2015.11.0,3400.8.0 PATH /learn/api/public/v1/courses/{courseId} DESCRIPTION VERSIONS 2015.11.0,3400.8.0 PATH /learn/api/public/v1/courses/{courseId} DESCRIPTION VERSIONS 2015.11.0,3400.8.0 PATH /learn/api/public/v1/courses/{courseId}/copy DESCRIPTION VERSIONS 3300.0.0,3800.0.0 PATH /learn/api/public/v2/courses DESCRIPTION VERSIONS 3400.8.0,3800.1.0 PATH /learn/api/public/v2/courses DESCRIPTION VERSIONS 3400.8.0,3800.1.0 PATH /learn/api/public/v2/courses/{courseId} DESCRIPTION VERSIONS 3400.8.0,3800.1.0 PATH /learn/api/public/v2/courses/{courseId} DESCRIPTION VERSIONS 3400.8.0,3800.1.0 PATH /learn/api/public/v2/courses/{courseId} DESCRIPTION VERSIONS 3400.8.0,3800.1.0 KEY AuthorizationCode FUNC {"summary":"AuthorizationCode","description":"Requests an OAuth 2 authorization code. Use of PKCE standard is optional, but highly recommended.\n\n**Since**: 3200.7.0","parameters":[{"$ref":"#/parameters/OAuth2AuthorizationCodeRequestParam.redirect_uri"},{"$ref":"#/parameters/OAuth2AuthorizationCodeRequestParam.response_type"},{"$ref":"#/parameters/OAuth2AuthorizationCodeRequestParam.client_id"},{"$ref":"#/parameters/OAuth2AuthorizationCodeRequestParam.scope"},{"$ref":"#/parameters/OAuth2AuthorizationCodeRequestParam.state"},{"name":"code_challenge","in":"query","description":"A code challenge to verify credentials along with the granted authorization code. It is used with the PKCE standard.\n\n**Since**: 3700.4.0","required":false,"type":"string"},{"name":"code_challenge_method","in":"query","description":"This is the method used to verify the code challenge using the PKCE standard. Blackboard only supports s256 as the code challenge method.\n\n**Since**: 3700.4.0","required":false,"type":"string"}],"method":"get","path":"/learn/api/public/v1/oauth2/authorizationcode","version":[["3200.7.0"]],"permissions":[]} KEY RequestToken FUNC {"summary":"RequestToken","description":"Requests an OAuth 2 access token.\n\n**Since**: 2015.11.0","parameters":[{"$ref":"#/parameters/OAuth2AccessTokenRequestParam.grant_type"},{"$ref":"#/parameters/OAuth2AccessTokenRequestParam.code"},{"name":"redirect_uri","in":"query","description":"The redirectUri to send the end user to once an access token response is made in Oauth2 Authorization Code Workflow\n\n**Since**: 3200.7.0","required":false,"type":"string"},{"name":"refresh_token","in":"query","description":"The refresh token granted for use by an application in Oauth2 Refresh Token Workflow\n\n**Since**: 3200.7.0","required":false,"type":"string"},{"name":"code_verifier","in":"query","description":"The code_verifier to be passed along with authorization code if PKCE standard was used to grant the authorization code.\n\n**Since**: 3700.4.0","required":false,"type":"string"}],"method":"post","path":"/learn/api/public/v1/oauth2/token","version":[["2015.11.0"]],"permissions":[]} KEY GetToken Info FUNC {"summary":"GetToken Info","description":"Requests an OAuth 2 access token info.\n\n**Since**: 3700.6.0","parameters":[{"name":"access_token","in":"query","description":"The application key and secret, encoded using RFC 2617 Basic authentication.","required":true,"type":"string"}],"method":"get","path":"/learn/api/public/v1/oauth2/tokeninfo","version":[["3700.6.0"]],"permissions":[]} KEY GetAnnouncements FUNC {"summary":"GetAnnouncements","description":"Return a list of Course Announcements. Users with the 'course.announcements.VIEW' entitlement can view 'available' Course Announcements. Users with the 'course.announcements.VIEW' & 'course.announcements.MODIFY' entitlement can view 'available' & 'unavailable' Course Announcements.\n\n**Since**: 3500.3.0","parameters":[{"$ref":"#/parameters/RowBasedPagingParams.offset"},{"$ref":"#/parameters/RowBasedPagingParams.limit"},{"name":"created","in":"query","description":"Search for announcements with a created date relative to this value. 'createdCompare' may also be sent to control search behavior.\n\n**Since**: 3500.3.0","required":false,"type":"string","format":"date-time"},{"name":"createdCompare","in":"query","description":"Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value.\n\n**Since**: 3500.3.0\n\n\n| Type | Description\n | --------- | --------- |\n| lessThan | |\n| greaterOrEqual | |\n","required":false,"type":"string","enum":["lessThan","greaterOrEqual"]},{"name":"modified","in":"query","description":"Search for announcements with a modified date relative to this value. 'createdCompare' may also be sent to control search behavior.\n\n**Since**: 3500.3.0","required":false,"type":"string","format":"date-time"},{"name":"modifiedCompare","in":"query","description":"Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value.\n\n**Since**: 3500.3.0\n\n\n| Type | Description\n | --------- | --------- |\n| lessThan | |\n| greaterOrEqual | |\n","required":false,"type":"string","enum":["lessThan","greaterOrEqual"]},{"name":"title","in":"query","description":"Search for announcements with a title like the provided value.\n\n**Since**: 3500.3.0","required":false,"type":"string"},{"name":"sort","in":"query","description":"Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc),created\" Supported fields are:\n\n- title\n- modified\n\n**Since**: 3500.3.0","required":false,"type":"string"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/announcements","version":[["3500.3.0"]],"permissions":[["course.announcements.VIEW"],["course.announcements.VIEW"],["course.announcements.MODIFY"]]} KEY CreateAnnouncement FUNC {"summary":"CreateAnnouncement","description":"Create a Course Announcement. Users with the 'course.announcements.CREATE' and 'course.announcements.VIEW' entitlements can create Course Announcements.\n\n**Since**: 3500.3.0","parameters":[{"in":"body","name":"input","required":true,"schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"The title of this Announcement."},"body":{"type":"string","format":"BbML","example":"<!-- {\"bbMLEditorVersion\":1} --><div data-bbid=\"bbml-editor-id_9c6a9556-80a5-496c-b10d-af2a9ab22d45\"> <h4>Header Large</h4> <h5>Header Medium</h5> <h6>Header Small</h6> <p><strong>Bold&nbsp;</strong><em>Italic&nbsp;<span style=\"text-decoration: underline;\">Italic Underline</span></em></p> <ul> <li><span style=\"text-decoration: underline;\"><em></em></span>Bullet 1</li> <li>Bullet 2</li> </ul> <p> <img src=\"@X@EmbeddedFile.requestUrlStub@X@bbcswebdav/xid-1217_1\"> <span>\"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\"</span> </p> <p><span>&lt;braces test=\"values\" other=\"strange things\"&gt;</span></p> <p>Header Small</p> <ol> <li>Number 1</li> <li>Number 2</li> </ol> <p>Just words followed by a formula</p> <p><img align=\"middle\" alt=\"3 divided by 4 2 root of 7\" class=\"Wirisformula\" src=\"@X@EmbeddedFile.requestUrlStub@X@sessions/EA5F7FF3DF32D271D0E54AF0150D924A/anonymous/wiris/49728c9f5b4091622e2f4d183d857d35.png\" data-mathml=\"«math xmlns=¨http://www.w3.org/1998/Math/MathML¨»«mn»3«/mn»«mo»/«/mo»«mn»4«/mn»«mroot»«mn»7«/mn»«mn»2«/mn»«/mroot»«/math»\"></p> <p><a href=\"http://www.blackboard.com\">Blackboard</a></p> </div>","description":"The message body of the Announcement. This field supports BbML; see <a target='_blank' href='https://docs.blackboard.com/learn/REST/Blackboard%20Markup%20Language%20-%20BbML.html'>here</a> for more information."},"draft":{"type":"boolean","description":"An indication of whether or not the Announcement is in draft status."},"availability":{"type":"object","description":"Settings controlling availability of the course to students.","title":"Availability","properties":{"duration":{"type":"object","description":"Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates.","title":"Duration","properties":{"start":{"type":"string","format":"date-time","description":"The date this Announcement starts being Available."},"end":{"type":"string","format":"date-time","description":"The date this Announcement stops being Available."}}}}}}}},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/fields"}],"method":"post","path":"/learn/api/public/v1/courses/{courseId}/announcements","version":[["3500.3.0"]],"permissions":[["course.announcements.CREATE"],["course.announcements.VIEW"]]} KEY GetAnnouncement FUNC {"summary":"GetAnnouncement","description":"Get a Course Announcement. Users with the 'course.announcements.VIEW' entitlement can view 'available' Course Announcements. Users with the 'course.announcements.VIEW' & 'course.announcements.MODIFY' entitlement can view 'available' & 'unavailable' Course Announcements.\n\n**Since**: 3500.3.0","parameters":[{"name":"announcementId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/announcements/{announcementId}","version":[["3500.3.0"]],"permissions":[["course.announcements.VIEW"],["course.announcements.VIEW"],["course.announcements.MODIFY"]]} KEY DeleteAnnouncement FUNC {"summary":"DeleteAnnouncement","description":"Delete a Course Announcement. Users with the 'course.announcements.DELETE' and 'course.announcements.VIEW' entitlements can delete Course Announcements.\n\n**Since**: 3500.3.0","parameters":[{"name":"announcementId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/fields"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/announcements/{announcementId}","version":[["3500.3.0"]],"permissions":[["course.announcements.DELETE"],["course.announcements.VIEW"]]} KEY UpdateAnnouncement FUNC {"summary":"UpdateAnnouncement","description":"Update a Course Announcement. Users with the 'course.announcements.MODIFY' and 'course.announcements.VIEW' entitlements can update Course Announcements.\n\n**Since**: 3500.3.0","parameters":[{"name":"announcementId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"in":"body","name":"input","required":true,"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of this Announcement."},"body":{"type":"string","format":"BbML","example":"<!-- {\"bbMLEditorVersion\":1} --><div data-bbid=\"bbml-editor-id_9c6a9556-80a5-496c-b10d-af2a9ab22d45\"> <h4>Header Large</h4> <h5>Header Medium</h5> <h6>Header Small</h6> <p><strong>Bold&nbsp;</strong><em>Italic&nbsp;<span style=\"text-decoration: underline;\">Italic Underline</span></em></p> <ul> <li><span style=\"text-decoration: underline;\"><em></em></span>Bullet 1</li> <li>Bullet 2</li> </ul> <p> <img src=\"@X@EmbeddedFile.requestUrlStub@X@bbcswebdav/xid-1217_1\"> <span>\"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\"</span> </p> <p><span>&lt;braces test=\"values\" other=\"strange things\"&gt;</span></p> <p>Header Small</p> <ol> <li>Number 1</li> <li>Number 2</li> </ol> <p>Just words followed by a formula</p> <p><img align=\"middle\" alt=\"3 divided by 4 2 root of 7\" class=\"Wirisformula\" src=\"@X@EmbeddedFile.requestUrlStub@X@sessions/EA5F7FF3DF32D271D0E54AF0150D924A/anonymous/wiris/49728c9f5b4091622e2f4d183d857d35.png\" data-mathml=\"«math xmlns=¨http://www.w3.org/1998/Math/MathML¨»«mn»3«/mn»«mo»/«/mo»«mn»4«/mn»«mroot»«mn»7«/mn»«mn»2«/mn»«/mroot»«/math»\"></p> <p><a href=\"http://www.blackboard.com\">Blackboard</a></p> </div>","description":"The message body of the Announcement. This field supports BbML; see <a target='_blank' href='https://docs.blackboard.com/learn/REST/Blackboard%20Markup%20Language%20-%20BbML.html'>here</a> for more information."},"draft":{"type":"boolean","description":"An indication of whether or not the Announcement is in draft status."},"availability":{"type":"object","description":"Settings controlling availability of the course to students.","title":"Availability","properties":{"duration":{"type":"object","description":"Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates.","title":"Duration","properties":{"start":{"type":"string","format":"date-time","description":"The date this Announcement starts being Available."},"end":{"type":"string","format":"date-time","description":"The date this Announcement stops being Available."}}}}}}}},{"$ref":"#/parameters/fields"}],"method":"patch","path":"/learn/api/public/v1/courses/{courseId}/announcements/{announcementId}","version":[["3500.3.0"]],"permissions":[["course.announcements.MODIFY"],["course.announcements.VIEW"]]} KEY GetCourse Meetings FUNC {"summary":"GetCourse Meetings","description":"Returns a list of course meetings for a given course id.\n\nThe \"course.attendance.VIEW\" entitlement is required to view a Course Meeting.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/RowBasedPagingParams.offset"},{"$ref":"#/parameters/RowBasedPagingParams.limit"},{"$ref":"#/parameters/CourseMeetingsSortCriteria.sort"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/meetings","version":[["3500.7.0"]],"permissions":[["course.attendance.VIEW"]]} KEY CreateCourse Meeting FUNC {"summary":"CreateCourse Meeting","description":"Creates a new Course Meeting within the provided Course/Organization Id. An attendance grade book column will automatically be generated if one does not exist.\n\nThe \"course.attendance.CREATE\" entitlement is required to create a Course Meeting.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"in":"body","name":"input","description":"JSON input object.","required":true,"schema":{"type":"object","required":["courseId","description","end","start","title"],"properties":{"courseId":{"type":"string","description":"The primary ID of the course."},"title":{"type":"string","description":"The title of the meeting"},"description":{"type":"string","description":"The description of the meeting"},"start":{"type":"string","format":"date-time","description":"The start time of meeting"},"end":{"type":"string","format":"date-time","description":"The end time of meeting"},"externalLink":{"type":"string","description":"The externalLink of course meeting"}}}},{"$ref":"#/parameters/fields"}],"method":"post","path":"/learn/api/public/v1/courses/{courseId}/meetings","version":[["3500.7.0"]],"permissions":[["course.attendance.CREATE"]]} KEY DeleteAll Meetings In Course FUNC {"summary":"DeleteAll Meetings In Course","description":"Deletes all course meetings in the course for the given course Id.\n\nThe 'course.attendance.DELETE' entitlement is required to delete Course Meetings.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/meetings","version":[["3500.7.0"]],"permissions":[["course.attendance.DELETE"]]} KEY GenerateAttendance Data Download Url FUNC {"summary":"GenerateAttendance Data Download Url","description":"Generate Download URL for Attendance Data.\n\nThe \"course.attendance.CREATE\" entitlement is required to generate download URL for attendance data.\n\n**Since**: ????","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/meetings/downloadUrl","version":[],"permissions":[["course.attendance.CREATE"]]} KEY GetAttendance Records By User Id FUNC {"summary":"GetAttendance Records By User Id","description":"Returns a list of Course Meeting Attendance for a given user id regardless of courses and meetings.\n\nThe \"course.attendance.VIEW\" entitlement is required to view a Course Meeting attendance.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/RowBasedPagingParams.offset"},{"$ref":"#/parameters/RowBasedPagingParams.limit"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/AttendanceRecordsSortCriteria.sort"},{"$ref":"#/parameters/UserIdParam.userId"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/meetings/users/{userId}","version":[["3500.7.0"]],"permissions":[["course.attendance.VIEW"]]} KEY DeleteAll Attendance Records By Course And User Id FUNC {"summary":"DeleteAll Attendance Records By Course And User Id","description":"Deletes all attendance records for the user in specific course.\n\nThe 'course.attendance.DELETE' entitlement is required to delete attendance records.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/UserIdParam.userId"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/meetings/users/{userId}","version":[["3500.7.0"]],"permissions":[["course.attendance.DELETE"]]} KEY DeleteAll Attendance By User Id FUNC {"summary":"DeleteAll Attendance By User Id","description":"Deletes all attendance records for the user. It will delete meeting attendance regardless of course.\n\nThe 'course.attendance.DELETE' entitlement is required to delete attendance records.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/UserIdParam.userId"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/meetings/users/{userId}/all","version":[["3500.7.0"]],"permissions":[["course.attendance.DELETE"]]} KEY GetCourse Meeting FUNC {"summary":"GetCourse Meeting","description":"Returns a Course Meeting for the given meeting Id.\n\nThe \"course.attendance.VIEW\" entitlement is required to view a Course Meeting.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}","version":[["3500.7.0"]],"permissions":[["course.attendance.VIEW"]]} KEY DeleteCourse Meeting FUNC {"summary":"DeleteCourse Meeting","description":"Delete the Course Meeting for the given course meeting Id.\n\nThe 'course.attendance.DELETE' entitlement is required to delete Course Meetings.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}","version":[["3500.7.0"]],"permissions":[["course.attendance.DELETE"]]} KEY UpdateCourse Meeting FUNC {"summary":"UpdateCourse Meeting","description":"Update the Course Meeting for the given Course/Organization.\n\nThe \"course.attendance.MODIFY\" entitlement is required to update a Course Meeting. The \"course.attendance.VIEW\" entitlement is required to view a Course Meeting.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"in":"body","name":"input","description":"JSON input object.","required":true,"schema":{"type":"object","properties":{"courseId":{"type":"string","description":"The primary ID of the course."},"title":{"type":"string","description":"The title of the meeting"},"description":{"type":"string","description":"The description of the meeting"},"start":{"type":"string","format":"date-time","description":"The start time of meeting"},"end":{"type":"string","format":"date-time","description":"The end time of meeting"},"externalLink":{"type":"string","description":"The externalLink of course meeting"}}}},{"$ref":"#/parameters/fields"}],"method":"patch","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}","version":[["3500.7.0"]],"permissions":[["course.attendance.MODIFY"],["course.attendance.VIEW"]]} KEY GetAttendance Records By Meeting Id FUNC {"summary":"GetAttendance Records By Meeting Id","description":"Returns a list of Course Meeting Attendance for a given meeting id.\n\nThe \"course.attendance.VIEW\" entitlement is required to view a Course Meeting attendance.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/RowBasedPagingParams.offset"},{"$ref":"#/parameters/RowBasedPagingParams.limit"},{"$ref":"#/parameters/CourseIdParam.courseId"},{"$ref":"#/parameters/AttendanceRecordsSortCriteria.sort"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users","version":[["3500.7.0"]],"permissions":[["course.attendance.VIEW"]]} KEY CreateAttendance Record FUNC {"summary":"CreateAttendance Record","description":"Creates a new Course Meeting Attendance within the provided Course/Organization Id.\n\nThe \"course.attendance.CREATE\" entitlement is required to create a Course Meeting Attendance.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"in":"body","name":"input","description":"JSON input object.","required":true,"schema":{"type":"object","required":["meetingId","status","userId"],"properties":{"meetingId":{"type":"string","description":"The primary id of the meeting."},"userId":{"type":"string","description":"The learn external id of the user."},"status":{"type":"string","description":"The attendance status of the user.\n\n\n| Type | Description\n | --------- | --------- |\n| Absent | |\n| Late | |\n| Present | |\n| Excused | |\n","enum":["Absent","Late","Present","Excused"]}}}},{"$ref":"#/parameters/fields"}],"method":"post","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users","version":[["3500.7.0"]],"permissions":[["course.attendance.CREATE"]]} KEY DeleteAll Records In Meeting FUNC {"summary":"DeleteAll Records In Meeting","description":"Deletes all attendance records in the course meeting for a given meeting Id.\n\nThe 'course.attendance.DELETE' entitlement is required to delete attendance records.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users","version":[["3500.7.0"]],"permissions":[["course.attendance.DELETE"]]} KEY UpdateAttendance Records FUNC {"summary":"UpdateAttendance Records","description":"Creates or updates attendance records for the meeting for all users in the course.\n\nUser required both of the entitlements below. If the user does not have the required entitlements,no records are created or modified. Entitlement | User Access ------------|----------- course.attendance.CREATE | Create Course/Organization Course Meeting Attendance course.attendance.MODIFY | Update Course/Organization Meeting Attendance\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"in":"body","name":"input","description":"JSON input object.","required":true,"schema":{"type":"object","required":["meetingId","status","userId"],"properties":{"meetingId":{"type":"string","description":"The primary id of the meeting."},"userId":{"type":"string","description":"The learn external id of the user."},"status":{"type":"string","description":"The attendance status of the user.\n\n\n| Type | Description\n | --------- | --------- |\n| Absent | |\n| Late | |\n| Present | |\n| Excused | |\n","enum":["Absent","Late","Present","Excused"]}}}},{"$ref":"#/parameters/fields"}],"method":"post","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/bulk","version":[["3500.7.0"]],"permissions":[["course.attendance.CREATE"],["course.attendance.MODIFY"]]} KEY GetAttendance Record FUNC {"summary":"GetAttendance Record","description":"Returns a Course Meeting Attendance information for the given meeting and user Id.\n\nThe \"course.attendance.VIEW\" entitlement is required to view a Course Meeting Attendance.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/UserIdParam.userId"},{"$ref":"#/parameters/fields"}],"method":"get","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId}","version":[["3500.7.0"]],"permissions":[["course.attendance.VIEW"]]} KEY DeleteAttendance Record FUNC {"summary":"DeleteAttendance Record","description":"Delete attendance record for meeting.It will delete meeting attendance within a course meeting.\n\nThe 'course.attendance.DELETE' entitlement is required to delete Attendance Record.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/UserIdParam.userId"}],"method":"delete","path":"/learn/api/public/v1/courses/{courseId}/meetings/{meetingId}/users/{userId}","version":[["3500.7.0"]],"permissions":[["course.attendance.DELETE"]]} KEY UpdateAttendance Record FUNC {"summary":"UpdateAttendance Record","description":"Update the Course Meeting Attendance data for the given Course/Organization.\n\nThe \"course.attendance.MODIFY\" entitlement is required to update a Course Meeting Attendance. The \"course.attendance.VIEW\" entitlement is required to view a Course Meeting attendance.\n\n**Since**: 3500.7.0","parameters":[{"$ref":"#/parameters/CourseIdParam.courseId"},{"name":"meetingId","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/UserIdParam.userId"},{"in":"body","name":"input","description":"JSON input object.","required":true,"schema":{"type":"object","p