Certifications Console screens and Portal pages cover most day-to-day course and offering work. For some lookups, an integration needs to call the Rhythm API directly. Use this reference when you need to show an event’s linked offerings with a sold-out mark, list the offerings an instructor leads, or find course registrations by course, application, order, or event registration.
Prerequisites
- You need the identifier for the event, instructor, course, application, order, or event registration you want to query. Each lookup needs that identifier before it can return results.
- Each lookup is limited to your Rhythm account automatically, and none accepts a parameter that reaches outside it.
Event Offerings
You link an offering to an event by editing the course offering itself. The offering is not tied to any event until you set that link there. If you remove the link, the offering stops appearing as one of that event’s add-ons, while other offerings still linked to the event continue to show.
Two lookups return the course offerings linked to an event, such as training sessions attached to a conference:
| Lookup | Sold-out mark | Filtered by publishing, date, or eligibility |
|---|---|---|
| Plain list of an event's offerings | No | No |
| Event's offerings with sold-out status | Yes | No |
Plain List of an Event's Offerings
This lookup returns every offering linked to the event, sorted by start date. It does not filter by publishing status, date, or sale window, so it includes past and unpublished offerings. If you show this list to a visitor, filter the results first so they only see the offerings you want to display.
Event's Offerings with Sold-Out Status
Use this lookup when a registration form needs to grey out a full session. It adds a sold-out flag to each offering linked to the event. When an offering has capacity, it is marked sold out once registrations in registered, attended, no show, or completed status reach that capacity.
Warning
An offering with capacity switched on but no number entered is always sold out. If every session for an event shows as full when you expect open seats, check whether each offering has a capacity number.
Like the plain list, this lookup does not filter by eligibility, publishing status, date, or sale window. It includes past offerings and shows the sold-out state based on their registration count.
Warning
This sold-out flag is what a registration form uses to grey out a full offering, but event registration has not always stopped a visitor from completing a registration past that limit. Support has seen a course offering added through event registration go through even though it was already at capacity, while direct course registration outside an event enforces the same capacity correctly. If you rely on capacity for an event-linked offering, check enrollment against capacity periodically instead of assuming event registration and direct registration always behave the same way.
An event-linked course offering's own Sell Until date is also not applied here. Support has reproduced a case where an offering with an associated event stopped appearing in the training offerings portal after its Sell Until date passed, but stayed selectable from the associated event's own registration page. If you need a sale window respected everywhere an offering can be reached, check the event registration page as well as the portal catalog.
Offerings an Instructor Leads
You can list the offerings a given instructor leads, sorted by start date. There is no date filter, so the results include both past and future offerings. This lookup returns only offerings where the instructor is the lead instructor. Offerings where the instructor is listed only as an additional instructor do not appear.
Tip
A queryable instructor names field is also available for course offerings, but it only reflects offerings created or updated after that field was released. An older offering that has not been saved since then may show a blank value there, even if it has an instructor.
Course Registrations by Course, Application, or Order
Three lookups return course registrations tied to a course, a certification application, or an order. Each lookup includes every registration, regardless of status:
| Look up registrations by | What you get |
|---|---|
| Course | Every registration for that course, across every offering, in date order |
| Application | The registrations linked to a certification application, which helps you check whether the application's course requirements have been met |
| Order | The registrations paid for by an order |
Tip
If you're building a query or registration list instead of calling this lookup directly, filter by Course Offering ID rather than Course Offering. Filtering by the Course Offering field can return no results even when matching registrations exist.
Registrations Linked to an Event Registration
When a Portal member registers for an event that includes training sessions, the course registrations created through that event registration carry the event registration’s identifier. This lookup returns those course registrations, oldest first, with every status included.
A signed-in Portal member can call this lookup only for an event registration that belongs to a contact they are allowed to act for. Certifications checks that relationship before returning results. If the event registration cannot be found, the request fails as not found.