Every school record that belongs to a program or phase includes that program or phase identifier. This reference explains how Rhythm builds those identifiers, shows names when a related record stores only the identifier, keeps requests inside your Rhythm account, and handles several program, phase, or past-phase changes in one API request.
How a Record's Identifier Ties It to a Program
A phase, school accreditation, report, visit, or team candidacy identifier starts with the program identifier and a colon. For example, a phase in program FAA might use the identifier FAA:CANDIDATE. Because the program identifier comes before the colon, it can use only letters, digits, and underscores.
Warning
Rhythm checks that the identifier prefix matches the program, but it does not check whether the rest of the identifier is meaningful. Rhythm also does not currently stop you from changing a program identifier after other records already reference it, but that change would detach those records from the program. Treat a program identifier as fixed once you have created records under it.
If you use the wrong identifier for a record, such as during a bulk cleanup or delete on a visit, Rhythm can return a false "not found" result even when a similar record exists. Double-check the exact identifier before you decide the record is missing.
How Program and Phase Names Resolve
When a related record stores only a program or phase identifier, Rhythm looks up the identifier and shows the name. You see this in places such as a breadcrumb, school page, search result, or billing run review screen. If you rename a program or phase, the new name appears after that lookup catches up. Until then, or if Rhythm cannot find the record, you may briefly see the identifier or a blank name instead of the name you expect.
Keeping Requests Inside Your Own Account
Every program, phase, and past-phase request stays within the Rhythm account for the signed-in session. Rhythm refuses a request that names a different account, unless the request comes from Rhythm staff. Within your own account, access to one program gives you access to every program in that account. A program is not its own security boundary.
Finding Out When a Record Changes
Rhythm records every creation, change, and deletion of a program, phase, or past phase, just as it records any other tracked change. To see when one of these records changed, who changed it, and what changed, see Audit History: What Is Recorded and How to View It. If an update does not change anything on the record, Rhythm does not publish a change.
Sending Several Operations in One Batch Request
You can send one batch request with several create, read, update, patch, or delete operations for programs, phases, or past phases. Rhythm checks each operation the same way it checks a single request, and each operation returns its own outcome.
Warning
Batch operations run in parallel and in no set order, so one operation cannot depend on another operation finishing first. If you name the same record identifier twice in one batch, the whole batch fails. Keep each identifier in a batch unique.
Related
- Accreditation Console and API Addresses
- Programs
- Phases