← Volver al índice de esquemas

SpeiCalendarResponse

Respuesta de `GET /v1/public/spei-calendar/{year}`. Un único recurso con los días inhábiles SPEI del año y su fuente, y en `meta.covered_years` los años que tienen calendario. Un año sin calendario responde `404`, no este cuerpo.

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
type*stringTipo de recurso JSON:API. Siempre `spei_calendar`.
id*stringAño del calendario (cuatro dígitos).
attributes*objectDatos del calendario del año.
year*integerAño del calendario (cuatro dígitos). Mismo valor que `id`.
non_business_days*arrayDías inhábiles que caen de lunes a viernes (`YYYY-MM-DD`), de menor a mayor. Los sábados y los domingos también son inhábiles y no se repiten aquí.
source*objectDisposición oficial de la que sale el calendario.
issuer*stringSiglas de la autoridad que emite la disposición, por ejemplo `CNBV`.
published_in*stringSiglas del medio oficial en el que se publicó la disposición, por ejemplo `DOF`.
published_on*string (date)Fecha de publicación de la disposición (`YYYY-MM-DD`).
title*stringTítulo oficial de la disposición, en español.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC`: La zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601`: Sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • GET /v1/public/spei-calendar/{year}