Servicios
Listar servicios
Devuelve los servicios vendibles del catálogo, paginados por cursor: personal, transporte y jornadas de trabajo que no proceden del inventario, con sus requisitos y etiquetas.
Ejemplos de petición
curl https://app.filmo.io/api/v1/services \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Filtra por tipo, colección y una única etiqueta. Ordenados por nombre; sort acepta un único campo. Los costes y el nombre interno no se publican; los filtros por fecha de creación y de actualización no están disponibles en este listado.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. services:read
Parámetros de consulta
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
Orden: un único campo, con un "-" inicial para descendente (p. ej. "-updatedAt"). Campos ordenables: name, serviceType, defaultQty, createdAt, updatedAt. Por defecto, "name". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Filtra por tipo: crew (personal), fleet (vehículos) o general.
Opciones disponibles: crew, fleet, general
Filtra por identificador de la colección a la que pertenece el servicio.
Límites: longitud mín. 1, longitud máx. 100
Filtra por collectionId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100
Filtra por identificador de etiqueta: servicios que llevan esa etiqueta.
Límites: longitud mín. 1, longitud máx. 100
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Respuesta
Respuesta correcta.
Esquema de la respuesta: ServiceDto
Sobre: ServiceList. 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 del servicio.
Nombre del servicio tal como lo ve el cliente.
Tipo: crew (personal), fleet (vehículos) o general.
Descripción; null si no tiene.
Cantidad que se añade por defecto a un pedido.
Si aparece como servicio planificable.
Si su importe cuenta para el total del documento.
Ruta de la colección a la que pertenece; null si no está en ninguna.
Recursos necesarios para prestarlo.
Mostrar atributos hijosOcultar atributos hijos
Lo necesario para prestarlo: personal o vehículo.
Opciones disponibles: personnel, vehicle
Cuántos hacen falta.
Límites: mín. 1
Etiquetas que debe tener el recurso asignado. Ej.: "Carné C".
Límites: máx. 20 elementos, cada uno: longitud máx. 100
Fecha de creación en ISO 8601 UTC; null si no consta.
Fecha de la ú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 relacionadasOperaciones
Servicio
Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.
¿Te ha resultado útil esta página?