AlmondTill/G3N API

Training requirement

The TrainingRequirement family — 7 operations.

A training requirement is the owner’s rule that people holding a certain kind of role must pass a course — one of the Playbook’s plays — and hold a valid certificate for it. The rule names the role template and the course, how many days after a role is granted the requirement falls due, and the pass mark a sitting must reach; when more than one rule binds the same person and course, the strictest pass mark wins. A rule is active, inactive (kept but not in force), or retired for good; the pair of role and course never changes once written.

Operations

OperationKindWhat it does
createTrainingRequirementmutationWrite a training rule — a role template must pass a course within so many days of grace, at this pass mark.
deactivateTrainingRequirementmutationTake a training rule out of force — kept, not counted, until reactivated.
doomTrainingRequirementmutationPermanently retire a training rule.
reactivateTrainingRequirementmutationPut a training rule back in force.
trainingRequirementqueryLook up one training rule — which kind of role must pass which course, the days of grace and the pass mark.
trainingRequirementsqueryYour organization group’s training rules, newest first.
updateTrainingRequirementmutationChange a training rule’s grace, pass mark or note — the role and the course never move.