Versions Compared

Key

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

MethodlistEnrollments

info
Panel
bgColor#eaf4fd

You can get all the account enrollments, enrollments related to certain learners or to certain courses, or both.


Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

...

ParameterTypeDescription
enrollmentarray

An array containing enrollments IDs

nextPageTokenstringThe token needed to continue to the next page
issuedCertificateId
The certificate ID (token) from the list of enrollments
certIssueDatedateThe date the certificate was issued
certExpiryDatedateThe certificate’s expiration date
enrollmentTypeGroupint32Possible values:

0 — assigned by an administrator

1 — added from the catalog


info
Panel
bgColor
#eaf4fd
The date of issue and expiration of the certificate can only be received for active enrollments. When using this method, you cannot get the data for archived or deleted enrollments.

...