Reissue a certificate via API

Introduction

A certificate that has already been awarded for a course or training plan can be reissued or updated. This would be particularly useful if, for example, you want to update the image used for the certificate template background or change other certificate template properties. The certificate expiry date will also change for any active certificates (valid and expiring) that have already been awarded, if their expiry date was changed with PATCH /odata/v2/Certificates({Id}).

Using LMS365 (Learn365) APIs, you can update the properties of awarded certificates using the same template or a new one, for example if the background image of a certificate is changed, or the template text was modified. This article describes the how to update the properties of an awarded certificate.

 

Prerequisites 

To update a certificate or reissue it, you need the following data:

If you want to use the same certificate template when updating a certificate or reissuing it, you'll need to get the ID of this template. The certificate template ID is displayed in the response when getting the ID of a certificate (see step 1), next to the TemplateId parameter.

You can also get the ID of a certificate template following the steps from the article on how to get the ID of the course. In this case, if the course has an associated certificate, the ID of the template will be displayed next to the CertificateTemplateId parameter in the response. If a course currently has no certificate, the response shows null next to the CertificateTemplateId parameter.

If you want to use a different certificate template when updating a certificate or reissuing it, you'll need to get the ID of the template from the LMS365 (Learn365) certificate templates storage.

To get the ID of a certificate template from the templates storage, follow these steps:

1. In the CertificateTemplates sections, find and expand the GET method /odata/v2/CertificatesTemplates with the Returns the list of Certificate Templates description and select Try it out.

2. After selecting Try it out, you can enter query options to filter the data in the response.


EXAMPLE

For example, entering CertificateType eq 'Course' in the $filter field will limit the response to show certificate templates that can be used only for courses.
Alternatively, if you have the title of a certificate, you can use it to get the ID of its template by entering Title eq 'certificate title' in the $filter field, for example Title eq 'Customer Care and Service'.

request_to_get_certificate_tempate_ID

3. When ready, select Execute to run the request.

4. Go to the Responses block to see the results.

  • Number 2xx (for example, 200) under Code shows that the request worked correctly. You can Download the data from the response to your computer in .JSON format.
  • If no query parameters were set to filter the response, in the Response body field, you can see
    all certificate templates of the tenant and search for a relevant one using Ctrl+F. Copy the ID of the certificate template, which is shown next to the Id parameter.

    List_of_certificate_templates_of_a_tenant

  • If query parameters were set, the response shows only the information that meets the conditions set. Copy the certificate template ID, which is shown next to the Id parameter.

    Certificate_template_ID_via_API

 

Reissue a certificate or update its properties

It's possible to partially update the properties of a certificate (the image used for the template background and the template itself) or reissue it. The certificate expiry date will also change for any active certificates (valid and expiring) that have already been awarded, if their expiry date was changed with PATCH /odata/v2/Certificates({Id}).

To do this, follow these steps:

1. Go to the Certificates section, find the POST method /odata/v2/Certificates({Id})/Reissue with the Reissue Certificate description and then select Try it out.

2. After selecting Try it out, complete both required fields:

  • In the key: Id field, enter the ID of the awarded certificate that you want to partially update or reissue.
  • In the Edit Value field, replace the string next to the "templateId" parameter with the ID of the certificate template that you want to use for the certificate.

3. Select Execute to run the request.

4. Go to the Responses block to see the results.

Number 2xx (for example, 204) under Code shows that the request worked correctly.

 

Reissue_certificate_response

 

To check the result, you can navigate to the LMS365 (Learn365) Admin Center > Users > select the relevant user > Download Certificate(s) and in the downloaded file, find the relevant certificate.

Another way to check the certificate is to go to the LMS365 (Learn365) Admin Center > Users > select the relevant user > View Learner's Progress > find the training with which the certificate is associated > select the eye icon next to the training > select the arrow icon to download the certificate as a PDF file and open it. 

Here is an example of an updated certificate, where the background image and text has been changed.

 

Example_of_an_updated_certificate

 

Was this article helpful?
1 out of 1 found this helpful

Comments

Article is closed for comments.