Saltar al contenido principal

Actualizar una actividad de la orden

PUThttps://carchost.fieldcontrol.com.br/orders/{id}/tasks/{taskId}

Actualiza una actividad. Envíe la actividad completa: el cuerpo sigue las mismas reglas de la creación, y position omitido vuelve a 100.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de ruta

idstringobligatorio

Identificador de la orden de servicio.

Ejemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

taskIdstringobligatorio

Identificador de la actividad.

Ejemplo: ZTllZjFiNzUtOGQ3MS00ZmE1LWFjNmUtYzlmNGQ1YzJiOWI3OjIyOTE1.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

statusstringobligatorio

Situación de la actividad.

Valores aceptados: pending, scheduled, in-progress, done, canceled, reported, on-route, paused.

employeeobject

Colaborador responsable.

Campos de employee
idstring

Identificador del colaborador.

namestring

Nombre del colaborador. Se aceptan textos, pero el vínculo se hace por el id.

taskTypeobject

Tipo de la actividad.

Campos de taskType
idstring

Identificador del tipo de actividad.

descriptionstring

Descripción de la actividad.

Acepta: null.

statusDescriptionstring

Observación sobre la situación. Hasta 6.000 caracteres.

Acepta: null.

durationinteger

Duración prevista, en minutos. Si se omite en la creación de la orden, la API usa la duración del tipo de orden de servicio.

Acepta: null.

positioninteger

Orden de la actividad dentro de la orden de servicio.

Predeterminado: 100.

archivedboolean

Archiva la actividad.

Predeterminado: false.

schedulingobjectobligatorio

Programación. type se calcula: con date y time pasa a scheduled-date-and-time, solo con date pasa a scheduled-date, y sin fecha pasa a non-scheduled.

Campos de scheduling
typestring

Se ignora; se calcula a partir de date y time.

Valores aceptados: scheduled-date, scheduled-date-and-time, non-scheduled.

datestring

Fecha (AAAA-MM-DD).

Acepta: null.

timestring

Horario (HH:MM:SS).

Acepta: null.

coordsobjectobligatorio

Coordenadas del lugar de la actividad.

Campos de coords
latitudenumberobligatorio
longitudenumberobligatorio

Respuestas

  • 200

    Actividad actualizada.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 404

    Recurso no encontrado. El cuerpo de la respuesta está vacío.

  • 422

    Cuerpo inválido (resourceValidationErr): colaborador no encontrado o inactivo, tipo de actividad inexistente o archivado, situación o programación inválidas. También cuando no se pueden mantener los colaboradores secundarios de la actividad. Identificador de la orden inválido: uriValidationErr.

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.