certifications

Organization the certification type belongs to. Always required.

Omit for a type owned by the organization directly.

Subject matters of the same organization to tag the type with; records filed under any of them satisfy its record-based rules. Omit for an untagged type; the set can be replaced later through PUT /certifications/{cert_id}/subjects.

at most 50 items

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like forklift-operator.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Omit or send empty for no description.

at most 2000 characters

Omit or send empty for no long-form markdown description.

at most 50000 characters

automatic: the user claims the certification themselves once every rule is satisfied. approval: the user requests it and a permission holder decides.

one of "automatic" | "approval"

1–300 characters

The file's content type; any type is allowed, but the upload pins this one.

1–200 characters

maximum 524288000

The pathname an upload ticket was issued for, after PUTting the file.

at least 1 character

1–300 characters

Omit or send empty to show the file name instead.

at most 200 characters

Omit to show the file on the page where its type allows it. Send false for a file meant to be downloaded and worked on locally — a blank form, a spreadsheet — so it renders as a download instead of an inline viewer.

Send null or empty to clear the label back to the file name.

at most 200 characters

New slot in the authored order.

minimum 0

Switches the file between showing on the page and being offered as a download only.

Replaces the type's subject-matter tags; send an empty array to clear them.

at most 50 items

The copy's name; omit for the original's with " (copy)" appended.

1–200 characters

The copy's slug, unique within the organization; omit for the first free `-copy`, `-copy-2`… of the original's. Slugs are lowercase letters and digits in words separated by single hyphens, like forklift-operator.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Send null to clear the description.

at most 2000 characters

Send null to clear the long-form markdown description.

at most 50000 characters

Changing the mode does not touch existing requests: pending requests on a now-automatic type remain decidable and withdrawable.

one of "automatic" | "approval"

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"

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

1–200 characters

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

Completed records required, for subject_record_count rules.

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 that must be passed, for quiz_pass rules. A quiz of the type's own organization.

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.

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 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.

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.

Send null to clear the label.

1–200 characters

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

Completed records required, for subject_record_count rules.

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 that must be passed, for quiz_pass rules. A quiz of the type's own organization.

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.

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 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.

Narrows a threshold rule to one of the type's subject tags; send null to count every tag again.

A certification type of the same organization as the role's department.

none: certify once, never again. anniversary: due recert_interval_months after each award. fixed_calendar: due on recert_anchor_month/recert_anchor_day each year.

one of "none" | "anniversary" | "fixed_calendar"

Months between recertifications, for the anniversary scheme.

Calendar month (1-12) the certification falls due, for fixed_calendar.

minimum 1 · maximum 12

Day of the anchor month (1-31, clamped to the month's length), for fixed_calendar.

minimum 1 · maximum 31

When the *initial* certification falls due for every holder of the role. A member's per-person due date overrides it; omit to set no role-level deadline.

none: certify once, never again. anniversary: due recert_interval_months after each award. fixed_calendar: due on recert_anchor_month/recert_anchor_day each year.

one of "none" | "anniversary" | "fixed_calendar"

Months between recertifications, for the anniversary scheme.

Calendar month (1-12) the certification falls due, for fixed_calendar.

minimum 1 · maximum 12

Day of the anchor month (1-31, clamped to the month's length), for fixed_calendar.

minimum 1 · maximum 31

When the *initial* certification falls due for every holder of the role. A member's per-person due date overrides it; omit to set no role-level deadline.