Saltar al contenido principal
GET
Get the effective window (official schedule ⊕ cut-off ⊕ calendar) and the configured cut-off

Autorizaciones

Authorization
string
header
requerido

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.

Encabezados

X-Request-Id
string<uuid>

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.

Parámetros de consulta

date
string<date>

Reference date (YYYY-MM-DD). Default: today in the institution time zone.

Respuesta

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.

date
string<date>
requerido

Calendar day that this window describes (YYYY-MM-DD).

effectiveClosesAt
string<date-time>
requerido

Effective close (UTC): the earlier of the official STR close and the institution cut-off.

effectiveOpensAt
string<date-time>
requerido

Effective opening of the window in the day (UTC).

isBusinessDay
boolean
requerido

false on a weekend or national holiday.

isOpen
boolean
requerido

If the window is open at the time of the query.

source
enum<string>
requerido

What decided the response: OFFICIAL_SCHEDULE (official schedule), OFFICIAL_SCHEDULE_WITH_CUTOFF (schedule narrowed by the cut-off), HOLIDAY, or WEEKEND.

Opciones disponibles:
OFFICIAL_SCHEDULE,
OFFICIAL_SCHEDULE_WITH_CUTOFF,
HOLIDAY,
WEEKEND
clientCutoffTime
string

Cut-off configured by the institution (HH:MM, local time). Missing when there is no cut-off.

officialClosesAt
string<date-time>

Official close of the STR (UTC). Missing on a day with no published schedule (weekend, holiday).