Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Header

Description

Authorization (required)Access token. You can obtain a token by making a request
ParameterDescription

enrollmentIds (optional)

The ID of an enrollment you want to get information on

...

ParameterDescription

response

An array with enrollment data
enrollmentIdThe ID of the enrollment
courseIdThe ID of the course
learnerIdThe ID of the user enrolled to the course
accessDateThe date when the learner is supposed to start studying the course
dueDate (optional)

Course completion date. The parameter appears in the response if a due date is specified

expirationDate (optional)

Course completion date. The parameter appears in the response if a due date is specified and shouldLockAfterDueDate is equal to 1

shouldLockAfterDueDate

Possible values:

0 means that access is granted

1 means that access is denied

enrollmentTypeGroup

Possible values:

0 — assigned by an administrator

1 — added from the catalog

сertificate

Certificate info

issuedCertificateId

The certificate ID (token) from the list of enrollments

issueDate

The date the certificate was issued

expiryDate

The certificate’s expiration date

...