Get the effective window (official schedule ⊕ cut-off ⊕ calendar) and the configured cut-off
Returns the operating window of a day, that is, when the institution accepts TED send requests. It combines the official STR schedule, the institution cut-off, and the holiday calendar. isOpen tells if the window is open now. source tells what decided the result (schedule, schedule with cut-off, holiday, or weekend).
Outside the window, a send request returns 422 TED-0020. On a non-business day, it returns 422 TED-0021. If the schedule or the calendar is unavailable, it returns 503 TED-0022. Give date for another day; times are in UTC.
Authorizations
JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.
Headers
Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.
Query Parameters
Reference date (YYYY-MM-DD). Default: today in the institution time zone.
Response
Effective window for the requested date (today by default).
Effective operating window of a day: the official STR schedule, narrowed by the institution cut-off and the holiday calendar. Outside it, send requests are refused with TED-0020/TED-0021.
Calendar day that this window describes (YYYY-MM-DD).
Effective close (UTC): the earlier of the official STR close and the institution cut-off.
Effective opening of the window in the day (UTC).
false on a weekend or national holiday.
If the window is open at the time of the query.
What decided the response: OFFICIAL_SCHEDULE (official schedule), OFFICIAL_SCHEDULE_WITH_CUTOFF (schedule narrowed by the cut-off), HOLIDAY, or WEEKEND.
OFFICIAL_SCHEDULE, OFFICIAL_SCHEDULE_WITH_CUTOFF, HOLIDAY, WEEKEND Cut-off configured by the institution (HH:MM, local time). Missing when there is no cut-off.
Official close of the STR (UTC). Missing on a day with no published schedule (weekend, holiday).

