For Developers

Rules Overview

An Integration Rule controls what educational data is shared through an integration. Rules evaluate conditions against schools, courses, sections, and user demographics to include or exclude matching records.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the rule.
created_dateDateDate when the rule was created.
updated_dateDateLast modification date.
nameStringDescriptive name for the rule.
stateStringRule state: draft, suggested, or active.
typeStringRule type: sharing or licensing.
targetStringTarget entity type: people, classes, schools, or enrollments.
conditionsArrayConditions. Each one has target, property, operator, and values.
integration_idUUIDIntegration ID to which this rule applies.

JSON Example

{
    "id": "7ca194a2-1982-4f91-8841-59128aa10234",
    "name": "Only High School Students",
    "state": "active",
    "type": "sharing",
    "target": "people",
    "conditions": [
        {
            "target": "person",
            "property": "grade_levels",
            "operator": "IN",
            "values": ["09", "10", "11", "12"]
        }
    ],
    "integration_id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92"
}