edubase_get_exam_certificates
Read-onlyIdempotent
Retrieve certificate settings for an exam, showing enabled status and merged preset configuration. Use to verify certificate issuance for successful exam results.
Instructions
Get the certificate settings of an exam. Certificates are only issued for the successful results, so they need a grading that decides whether the test was successful (see the certificates flag in edubase_get_quiz_grading_presets). Only the state of the certificates is returned when they are not enabled for the exam. When the certificates are configured by a preset, the settings of the preset are merged into the returned configuration. The certificates issued for the individual results can be looked up with edubase_get_exam_certificates_user.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | Yes | exam identification string |
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) |