Disponibilidad

Listar las indisponibilidades de un recurso

Devuelve las ventanas en las que una persona, un vehículo o un espacio NO está disponible.

GET
/api/v1/availability/unavailabilities

Ejemplos de petición

curl 'https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff' \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "unavailability_9f3a2b",
      "resourceType": "Example resource type",
      "resourceId": "resource_9f3a2b",
      "resourceName": "Example resource name",
      "startDate": "2026-09-01T08:00:00.000Z",
      "endDate": "2026-09-01T08:00:00.000Z",
      "state": "Madrid",
      "absenceType": "Example absence type",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

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

resourceTypestringObligatorio

Qué recursos consultar.

Opciones disponibles: staff, vehicle, space

resourceIdstring

Limita a un recurso concreto.

Límites: longitud mín. 1

startDatestring<date-time>

Inicio de la ventana, en ISO 8601 con desplazamiento.

endDatestring<date-time>

Fin de la ventana, en ISO 8601 con desplazamiento.

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: UnavailabilityDto

Sobre: UnavailabilityList. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Mostrar atributos hijos
data.idstring

Identificador único de la indisponibilidad.

data.resourceTypestring

Qué recurso: staff, vehicle o space.

data.resourceIdstring

Identificador de ese recurso.

data.resourceNamestring | null

Nombre del recurso; null si no consta.

data.startDatestring<date-time>

Inicio de la indisponibilidad en ISO 8601 UTC.

data.endDatestring<date-time>

Fin de la indisponibilidad en ISO 8601 UTC.

data.statestring

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.

data.absenceTypestring | null

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.

data.updatedAtstring<date-time> | null

Última modificación en ISO 8601 UTC; null si no está registrada.

paginationobject

Metadatos de paginación por cursor opaco.

Mostrar atributos hijos
pagination.nextCursorstring | null

Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.

pagination.hasMoreboolean

Si existen más resultados después de esta página.

pagination.totalinteger

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

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta 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

  • Catálogo e inventario

    Indisponibilidad

    Ventana en la que un recurso NO está disponible.