Disponibilidad

Declarar una indisponibilidad

Declara que un recurso no está disponible en una ventana: vacaciones, un mantenimiento, un cierre.

POST
/api/v1/availability/unavailabilities

Ejemplos de petición

curl https://app.filmo.io/api/v1/availability/unavailabilities \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "resourceType": "staff",
  "resourceId": "stf_ana",
  "startDate": "2026-08-01T00:00:00+02:00",
  "endDate": "2026-08-15T23:59:59+02:00",
  "state": "unavailable",
  "absenceType": "vacation"
}'
{
  "data": {
    "availability": {
      "id": "availability_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"
    },
    "warningCount": 1
  }
}

Generado a partir del esquema

reason se ACEPTA y no se devuelve: se queda en Filmo para quien tenga acceso. Para una persona o un vehículo, los compromisos que se solapan no bloquean: la indisponibilidad se registra y warningCount indica cuántos compromisos ya reservados se solapan con ella. Un espacio es distinto: declararlo unavailable en una ventana en la que está reservado responde 409 conflict y no se escribe nada, así que en un espacio warningCount es siempre 0. También responde 409 si ya existe una indisponibilidad idéntica (mismo recurso, ventana, estado, tipo y motivo). Responde 400 validation_error, con errors[0].path en el campo, cuando endDate no es posterior a startDate, cuando resourceId no existe o pertenece a otra cuenta, y cuando absenceType no es uno de los de su tipo de recurso: vacation, sick, personal, training u other para el personal; maintenance, inspection, repair, reserved u other para los vehículos; academic, maintenance, event, closure u other para los espacios. En un espacio responde 503 service_unavailable mientras las indisponibilidades de espacios estén desactivadas para la cuenta.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. availability:write

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

Cuerpo

application/json

Esquema del cuerpo: UnavailabilityCreateBody

resourceTypestringObligatorio

Qué recurso se declara no disponible.

Opciones disponibles: staff, vehicle, space

resourceIdstringObligatorio

Identificador de ese recurso.

Límites: longitud mín. 1

startDatestring<date-time>Obligatorio

Inicio, en ISO 8601 con desplazamiento.

endDatestring<date-time>Obligatorio

Fin, en ISO 8601 con desplazamiento.

statestringObligatorio

Lo que se declara para esa ventana.

Opciones disponibles: available, unavailable, unknown

absenceTypestring

Tipo de ausencia.

Opciones disponibles: vacation, sick, personal, training, maintenance, inspection, repair, reserved, academic, event, closure, other

reasonstring

Motivo. Se guarda en Filmo y la API NO lo devuelve.

Límites: longitud máx. 500

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: UnavailabilityResultDto

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

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Resultado de declarar o actualizar una indisponibilidad.

Mostrar atributos hijos
data.availabilityobject

La indisponibilidad tal como queda ahora.

Mostrar atributos hijos
data.availability.idstring

Identificador único de la indisponibilidad.

data.availability.resourceTypestring

Qué recurso: staff, vehicle o space.

data.availability.resourceIdstring

Identificador de ese recurso.

data.availability.resourceNamestring | null

Nombre del recurso; null si no consta.

data.availability.startDatestring<date-time>

Inicio de la indisponibilidad en ISO 8601 UTC.

data.availability.endDatestring<date-time>

Fin de la indisponibilidad en ISO 8601 UTC.

data.availability.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.availability.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.availability.updatedAtstring<date-time> | null

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

data.warningCountinteger

Compromisos del recurso que se solapan con esta indisponibilidad.

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.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.
503service_unavailableLa función en la que escribe esta operación está desactivada para la cuenta. La petición es correcta; vuelve a funcionar en cuanto se activa la función.

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