Pular para o conteúdo principal

Atualizar uma atividade da ordem

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

Atualiza uma atividade. Envie a atividade completa: o corpo segue as mesmas regras da criação, e position omitido volta para 100.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

taskIdstringobrigatório

Identificador da atividade.

Exemplo: ZTllZjFiNzUtOGQ3MS00ZmE1LWFjNmUtYzlmNGQ1YzJiOWI3OjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

statusstringobrigatório

Situação da atividade.

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

employeeobject

Colaborador responsável.

Campos de employee
idstring

Identificador do colaborador.

namestring

Nome do colaborador. Textos são aceitos, mas o vínculo é feito pelo id.

taskTypeobject

Tipo da atividade.

Campos de taskType
idstring

Identificador do tipo de atividade.

descriptionstring

Descrição da atividade.

Aceita: null.

statusDescriptionstring

Observação sobre a situação. Até 6.000 caracteres.

Aceita: null.

durationinteger

Duração prevista, em minutos. Se omitida na criação da ordem, a API usa a duração do tipo de OS.

Aceita: null.

positioninteger

Ordem da atividade dentro da ordem de serviço.

Padrão: 100.

archivedboolean

Arquiva a atividade.

Padrão: false.

schedulingobjectobrigatório

Agendamento. type é calculado: com date e time vira scheduled-date-and-time, só com date vira scheduled-date, e sem data vira non-scheduled.

Campos de scheduling
typestring

Ignorado; calculado a partir de date e time.

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

datestring

Data (AAAA-MM-DD).

Aceita: null.

timestring

Horário (HH:MM:SS).

Aceita: null.

coordsobjectobrigatório

Coordenadas do local da atividade.

Campos de coords
latitudenumberobrigatório
longitudenumberobrigatório

Respostas

  • 200

    Atividade atualizada.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 404

    Recurso não encontrado. O corpo da resposta é vazio.

  • 422

    Corpo inválido (resourceValidationErr): colaborador não encontrado ou inativo, tipo de atividade inexistente ou arquivado, situação ou agendamento inválidos. Também quando os colaboradores secundários da atividade não podem ser mantidos. Identificador da ordem inválido: uriValidationErr.

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.