Operaciones

Servicio del planificador

Servicio de personal o de flota pendiente de cobertura, o ya cubierto.

Esquemas: PlannerServiceDto

{
  "orderServiceId": "string",
  "rowKind": "summary",
  "orderId": "string",
  "orderNumber": "string",
  "orderStatus": "string",
  "contactName": "Example",
  "projectId": "string",
  "projectName": "Example",
  "serviceId": "string",
  "serviceName": "Example",
  "serviceType": "string",
  "staffMemberId": "string",
  "vehicleId": "string",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "status": "string",
  "qty": 1,
  "taskId": "string",
  "requirements": [
    {
      "requiredResourceType": "personnel",
      "qty": 1
    }
  ]
}

Generado a partir del esquema

Un servicio de personal o de flota de un pedido que está pendiente de cobertura o ya cubierto. Cuando staffMemberId y vehicleId son null, el servicio está sin cubrir. El identificador que usas para asignarlo es orderServiceId, no un id. Lista los servicios de una ventana de fechas con GET /api/v1/planner/services.

Atributos

orderServiceIdstring

Identificador de la línea de servicio. Es el que se pasa al asignar.

rowKindstring

Qué fila es esta. Un servicio llega como UNA fila summary (el propio servicio, con staffMemberId y vehicleId siempre null) más una fila detail por cada persona o vehículo asignado, todas con el mismo orderServiceId. Un servicio está cubierto cuando tiene filas detail con un asignado, y descubierto cuando solo tiene la fila summary.

Opciones disponibles: summary, detail

orderIdstring

Pedido al que está asociado el servicio; una cadena vacía en los servicios internos, que no pertenecen a ningún pedido.

orderNumberstring

Número legible de ese pedido; una cadena vacía en los servicios internos.

orderStatusstring

Estado del pedido.

contactNamestring | null

Cliente del pedido; null si no consta.

projectIdstring | null

Proyecto asociado; null si no aplica.

projectNamestring | null

Nombre del proyecto; null si no procede.

serviceIdstring

Servicio del catálogo del que procede.

serviceNamestring

Nombre del servicio.

serviceTypestring

Tipo: crew, fleet o general.

staffMemberIdstring | null

Miembro del personal asignado. Solo lo llevan las filas detail; es null en la fila summary aunque el servicio esté cubierto.

vehicleIdstring | null

Vehículo asignado. Solo lo llevan las filas detail; es null en la fila summary aunque el servicio esté cubierto.

startDatestring<date-time>

Inicio del servicio en ISO 8601 UTC.

endDatestring<date-time>

Fin del servicio en ISO 8601 UTC.

statusstring

Estado de la línea de servicio.

qtynumber

Cuántas unidades del servicio se solicitan.

taskIdstring | null

Tarea de la agenda vinculada; null si no hay ninguna.

requirementsobject[]

Recursos necesarios para cubrirlo.

Mostrar atributos hijos

requirements.requiredResourceTypestring

Lo necesario: personal o vehículo.

Opciones disponibles: personnel, vehicle

requirements.qtynumber

Cuántos hacen falta.

Valores

rowKind: summary, detail

Lo devuelven

GET /api/v1/planner/services — Listar los servicios por cubrir

Lo modifican

Ninguna operación.

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican