edubase_post_exam_certificates
Add or update an exam's certificate settings: enable issuance, set titles, serial numbers, expiration, signatures, branding, and renewal rules. Configure these details to match your requirements.
Instructions
Change individual certificate settings of an exam. Every setting other than enabled requires the certificates to be enabled for the exam, and the items displayed on the certificates have to be switched on before their own settings can be configured (for example show_serial before the serial_ settings). The certificates configured by a preset can only be replaced completely, see edubase_put_exam_certificates. The settings cannot be changed while the exam is locked.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | Yes | exam identification string | |
| notes | No | notes displayed at the bottom of the certificates | |
| renew | No | whether the certificates can be renewed, requires show_expiration (false: the certificates cannot be renewed, true: the certificates can be renewed any time, number: the number of days the renewal is available from, relative to the expiry, 0 is the day of the expiry, negative values open the renewal before it, at most the validity period earlier), default: false | |
| text1 | No | text displayed under the data of the examinee, the multi line texts (text1, text2 and notes) support basic formatting (bold, italic, underline, subscript, superscript) and line breaks | |
| text2 | No | text displayed under the results, above the date of the test | |
| title | No | title of the certificates, certificates are only issued once they have a title | |
| enabled | No | issue certificates for the exam, needs the certificate feature to be enabled for the user, not available for surveys, and needs a grading that decides whether the test was successful (see the certificates flag in edubase_get_quiz_grading_presets), the configuration is kept when the certificates are disabled | |
| language | No | language of the certificates, only the languages EduBase is translated to are available (default: language of the exam) | |
| timezone | No | timezone of the dates on the certificates, or "default" if the timezone of the exam should be used | |
| text_date | No | text displayed before the date of the test | |
| email_send | No | send the certificates to the examinees in email automatically, needs the certificate email sending feature to be enabled on the instance | |
| expiration | No | validity period of the certificates in days, between 0 and 9999, requires show_expiration and it is mandatory when the expiration is configured for the first time | |
| show_custom | No | display custom user data | |
| show_result | No | display the result of the test | |
| show_serial | No | give a serial number to the certificates | |
| custom_fields | No | custom user data to display as extra data, requires show_custom, at most three fields can be displayed, the custom user data fields of the exam are identified by their label (see edubase_get_exam_fields), the data fields of the user accounts by their customer_ prefixed name, send an empty list to remove every field | |
| hide_timezone | No | hide the timezone information | |
| result_format | No | format of the displayed result, requires show_result (points-percent-time: points, result in percentage and the time spent with the test, points-percent: points and result in percentage, points: points only, percent: result in percentage only), default: points-percent-time | |
| serial_format | No | format of the serial numbers, requires show_serial and it is mandatory when the serial numbers are configured for the first time (prefix-year-index: prefix, the year of the test and the index, prefix-date-index: prefix, the date of the test and the index, prefix-index: prefix and index, written together), none of the serial_ settings can be changed anymore once a certificate is issued for the exam | |
| serial_prefix | No | prefix of the serial numbers, requires show_serial, the serial numbers are only unique within the exam, so a unique prefix is recommended | |
| branding_image | No | logo of the branding, the same way as with signature_left_image | |
| branding_line1 | No | name of the organization, requires show_custom_branding and it is mandatory when the branding is displayed | |
| branding_line2 | No | second line of the branding | |
| branding_line3 | No | third line of the branding | |
| branding_line4 | No | fourth line of the branding | |
| manual_renewal | No | the renewal has to be approved by a supervisor, requires renew | |
| show_signature | No | display signatures | |
| signature_left | No | display the signature of the first organizer, requires show_signature, the lines of the signature are kept when it is disabled | |
| signature_user | No | display a signature line for the examinee, requires show_signature | |
| show_expiration | No | expire the certificates and display their validity | |
| signature_right | No | display the signature of the second organizer, the same way as with signature_left | |
| signature_stamp | No | stamp displayed between the signatures, the same way as with signature_left_image | |
| branding_edubase | No | display the EduBase logo, it can only be removed with the matching feature enabled | |
| serial_separator | No | separator between the parts of the serial numbers, requires show_serial, always empty with the prefix-index format (default: /) | |
| supervisors_only | No | only allow the supervisors to issue the certificates, so the examinees cannot get their own ones | |
| grading_threshold | No | threshold of the certificates in percentage, overriding the threshold of the grading, certificates are only issued above it. Accepts a number or a numeric string between 0 and 100, or "default" if the threshold of the grading should be used | |
| custom_user_fields | No | custom user data to display together with the data of the examinee, the same way as with custom_fields | |
| serial_index_digits | No | minimum length of the index in the serial numbers, between 1 and 16, requires show_serial (default: 4) | |
| show_custom_branding | No | display custom branding (logo and organization name) | |
| signature_left_image | No | image of the first signature, the identifier of an image uploaded to the filebin replaces the image (supported formats: JPEG, WebP, PNG), the white background of the signatures and the stamp is removed automatically, but transparent PNG images are recommended (true: display the image that is already uploaded, false: keep the uploaded image, but do not display it) | |
| signature_left_line1 | No | name of the first organizer, mandatory when the signature is displayed | |
| signature_left_line2 | No | second line of the first signature | |
| signature_left_line3 | No | third line of the first signature | |
| signature_left_line4 | No | fourth line of the first signature | |
| signature_right_image | No | image of the second signature, the same way as with signature_left_image | |
| signature_right_line1 | No | name of the second organizer, mandatory when the signature is displayed | |
| signature_right_line2 | No | second line of the second signature | |
| signature_right_line3 | No | third line of the second signature | |
| signature_right_line4 | No | fourth line of the second signature | |
| download_automatically | No | download the certificate automatically when the examinee opens the results page | |
| show_birthdate_birthplace | No | display the birth date and the birth place of the examinee | |
| automatic_renewal_approval | No | approve the renewal automatically, but keep it revocable, requires manual_renewal | |
| expiration_notification_emails | No | email addresses to notify about the expiring certificates, requires show_expiration, the examinees of the exam are notified automatically about their renewable certificates, these notifications are sent to the specified addresses only, send an empty list to remove every address |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | Yes | exam identification string | |
| notes | No | notes displayed at the bottom of the certificates | |
| renew | No | whether the certificates can be renewed (only present if show_expiration is enabled), false: the certificates cannot be renewed, true: the certificates can be renewed any time, number: the number of days the renewal is available from, relative to the expiry (0 is the day of the expiry, negative values open the renewal before it) | |
| text1 | No | text displayed under the data of the examinee, the multi line texts (text1, text2 and notes) are returned with basic HTML formatting and line breaks | |
| text2 | No | text displayed under the results, above the date of the test | |
| title | No | title of the certificates | |
| preset | No | identification string of the certificate preset configuring the certificates (see edubase_get_exam_certificates_presets), null if the certificates are configured manually | |
| enabled | Yes | certificates are issued for the exam, the configuration itself is only returned when the certificates are enabled | |
| language | No | language of the certificates | |
| timezone | No | timezone of the dates on the certificates, null if the timezone of the exam is used | |
| text_date | No | text displayed before the date of the test | |
| configured | Yes | the certificates are configured, so they can be issued | |
| email_send | No | the certificates are sent to the examinees in email automatically | |
| expiration | No | validity period of the certificates in days (only present if show_expiration is enabled) | |
| show_custom | No | custom user data is displayed | |
| show_result | No | the result of the test is displayed | |
| show_serial | No | the certificates get a serial number | |
| custom_fields | No | custom user data displayed as extra data (only present if show_custom is enabled), the custom user data fields of the exam are identified by their label (see edubase_get_exam_fields), the data fields of the user accounts by their customer_ prefixed name | |
| hide_timezone | No | the timezone information is hidden | |
| result_format | No | format of the displayed result (only present if show_result is enabled) | |
| serial_format | No | format of the serial numbers (only present if show_serial is enabled) | |
| serial_prefix | No | prefix of the serial numbers (only present if show_serial is enabled) | |
| branding_image | No | the uploaded logo is displayed (only present if show_custom_branding is enabled) | |
| branding_line1 | No | name of the organization (only present if show_custom_branding is enabled) | |
| branding_line2 | No | second line of the branding (only present if show_custom_branding is enabled) | |
| branding_line3 | No | third line of the branding (only present if show_custom_branding is enabled) | |
| branding_line4 | No | fourth line of the branding (only present if show_custom_branding is enabled) | |
| manual_renewal | No | the renewal has to be approved by a supervisor (only present if show_expiration is enabled) | |
| show_signature | No | signatures are displayed | |
| signature_left | No | the signature of the first organizer is displayed (only present if show_signature is enabled) | |
| signature_user | No | a signature line is displayed for the examinee (only present if show_signature is enabled) | |
| show_expiration | No | the certificates expire and their validity is displayed | |
| signature_right | No | the signature of the second organizer is displayed (only present if show_signature is enabled) | |
| signature_stamp | No | the uploaded stamp is displayed between the signatures (only present if show_signature is enabled) | |
| branding_edubase | No | the EduBase logo is displayed (only present if show_custom_branding is enabled) | |
| serial_separator | No | separator between the parts of the serial numbers (only present if show_serial is enabled) | |
| supervisors_only | No | only the supervisors can issue the certificates, the examinees cannot get their own ones | |
| grading_threshold | No | threshold of the certificates in percentage, overriding the threshold of the grading, null if the threshold of the grading is used | |
| custom_user_fields | No | custom user data displayed together with the data of the examinee (only present if show_custom is enabled) | |
| serial_index_digits | No | minimum length of the index in the serial numbers (only present if show_serial is enabled) | |
| show_custom_branding | No | custom branding (logo and organization name) is displayed | |
| signature_left_image | No | the uploaded image of the first signature is displayed (only present if show_signature is enabled) | |
| signature_left_line1 | No | name of the first organizer (only present if show_signature is enabled) | |
| signature_left_line2 | No | second line of the first signature (only present if show_signature is enabled) | |
| signature_left_line3 | No | third line of the first signature (only present if show_signature is enabled) | |
| signature_left_line4 | No | fourth line of the first signature (only present if show_signature is enabled) | |
| signature_right_image | No | the uploaded image of the second signature is displayed (only present if show_signature is enabled) | |
| signature_right_line1 | No | name of the second organizer (only present if show_signature is enabled) | |
| signature_right_line2 | No | second line of the second signature (only present if show_signature is enabled) | |
| signature_right_line3 | No | third line of the second signature (only present if show_signature is enabled) | |
| signature_right_line4 | No | fourth line of the second signature (only present if show_signature is enabled) | |
| download_automatically | No | the certificate is downloaded automatically when the examinee opens the results page | |
| show_birthdate_birthplace | No | the birth date and the birth place of the examinee are displayed | |
| automatic_renewal_approval | No | the renewal is approved automatically, but it stays revocable (only present if show_expiration is enabled) | |
| expiration_notification_emails | No | email addresses notified about the expiring certificates (only present if show_expiration is enabled) |