CreateCertificationRuleRequest

A request or response body; the type column links to the schemas it refers to.

CreateCertificationRuleRequest

FieldTypeRequiredDescription
rule_kindstringyes

subject_hours: evidenced hours on the type's subjects (or on subject_matter_id alone) must reach threshold_hours. subject_record_count: completed records on the subjects (or on subject_matter_id alone) must reach threshold_count. evidence_document: a completed record on the subject must carry evidence of evidence_type (a pass_fail row counts only when it records a pass). manual_sign_off: a permission holder must record a sign-off for the rule. quiz_pass: the user must have a passing attempt of the quiz named by quiz_id. external_course_pass: the user must have a passing grade of the external LMS course named by external_course_id. scorm_course_complete: the user must have completed the hosted SCORM course named by scorm_course_id. job_aid_viewed: the user must have opened the job aid named by job_aid_id.

one of "subject_hours" | "subject_record_count" | "evidence_document" | "manual_sign_off" | "quiz_pass" | "external_course_pass" | "scorm_course_complete" | "job_aid_viewed"

labelstringno

Human label shown wherever the rule's progress is, e.g. "20 simulator hours".

1–200 characters

threshold_hoursnumberno

Hours required, for subject_hours rules. Counted from quantity evidence in hours or minutes, plus the elapsed time of date_range evidence.

threshold_countintegerno

Completed records required, for subject_record_count rules.

evidence_typestringno

Evidence type that must be present, for evidence_document rules. A pass_fail rule is met only by a row recording a pass.

one of "score" | "date_range" | "quantity" | "url" | "file" | "pass_fail" | "note"

quiz_idstring (uuid)no

Quiz that must be passed, for quiz_pass rules. A quiz of the type's own organization.

external_course_idstring (uuid)no

Catalogue id of the external LMS course that must be passed, for external_course_pass rules. A course of the type's own organization. Passing is decided by the course: its passing_score when set, the imported passed flag otherwise.

scorm_course_idstring (uuid)no

Hosted SCORM course that must be completed, for scorm_course_complete rules. A course of the type's own organization. Completion is what the course's completion records count: an attempt the module reported complete without an explicit failed verdict.

job_aid_idstring (uuid)no

Job aid that must be viewed, for job_aid_viewed rules. An aid of the type's own organization. Viewing is an open of the aid's page (POST /job-aids/{job_aid_id}/views, which the page does on every load), inside the current recertification window; opens of its individual files do not count.

subject_matter_idstring (uuid)no

Narrows a subject_hours or subject_record_count rule to one subject: only records filed under it count. Must be one of the type's own subject tags; omit to count records on every tag of the type.

jsonExample
{
  "rule_kind": "subject_hours",
  "label": "string",
  "threshold_hours": 20,
  "threshold_count": 3,
  "evidence_type": "score",
  "quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "external_course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "scorm_course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "job_aid_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "subject_matter_id": "1b671a64-40d5-491e-99b0-da01ff1f3341"
}