Disponibilidad
Listar las indisponibilidades de un recurso
Devuelve las ventanas en las que una persona, un vehículo o un espacio NO está disponible.
Ejemplos de petición
curl 'https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff' \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
absenceType se emite para vehículos y espacios, donde es operativo, y NO para personas, donde sería un dato de salud. El motivo de la indisponibilidad no se emite nunca. Solo se devuelven las declaraciones con state: unavailable que aún no han terminado (actuales o futuras): una indisponibilidad desaparece de la lista cuando pasa su fecha de fin, y las ventanas available o unknown nunca se listan.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. availability:read
Parámetros de consulta
Qué recursos consultar.
Opciones disponibles: staff, vehicle, space
Limita a un recurso concreto.
Límites: longitud mín. 1
Inicio de la ventana, en ISO 8601 con desplazamiento.
Fin de la ventana, en ISO 8601 con desplazamiento.
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Respuesta
Respuesta correcta.
Esquema de la respuesta: UnavailabilityDto
Sobre: UnavailabilityList. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Mostrar atributos hijosOcultar atributos hijos
Identificador único de la indisponibilidad.
Qué recurso: staff, vehicle o space.
Identificador de ese recurso.
Nombre del recurso; null si no consta.
Inicio de la indisponibilidad en ISO 8601 UTC.
Fin de la indisponibilidad en ISO 8601 UTC.
Estado declarado. Este listado solo devuelve ventanas unavailable que aún no han terminado, así que aquí siempre es unavailable; available y unknown existen como declaraciones pero no se listan.
Tipo de ausencia. Solo se emite para vehículos y espacios, donde es operativo; para el personal es un dato de salud y se devuelve como null.
Última modificación en ISO 8601 UTC; null si no está registrada.
Metadatos de paginación por cursor opaco.
Mostrar atributos hijosOcultar atributos hijos
Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.
Si existen más resultados después de esta página.
Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece includeTotal=true.
Límites: mín. 0
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
Petición no válida (validation_error): consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasCatálogo e inventario
Indisponibilidad
Ventana en la que un recurso NO está disponible.
¿Te ha resultado útil esta página?