Pular para o conteúdo principal

Atualizar uma solicitação de serviço

PUThttps://carchost.fieldcontrol.com.br/tickets/{id}

Atualiza os dados de uma solicitação. status e archived não mudam por aqui, e cliente, tipo de OS, produtos, serviços e trajeto só são gravados na criação.

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 solicitação.

Exemplo: YTJmYmM4ZDEtNGQ3Mi00ZmVlLTk1ZjktMjU1ZWIyNzk2YzJjOjIyOTE1.

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.

namestringobrigatório

Nome de quem pediu o atendimento.

Mínimo de 5 caracteres.

messagestringobrigatório

Mensagem da solicitação.

subjectstring

Assunto. Igual ao nome de um tipo de OS, permite reconhecer solicitações de clientes corporativos.

identifierstring

Número da solicitação. O caractere # é reservado.

expiredAtstring

Data de validade da solicitação.

externalobject
Campos de external
idstring

Identificador da solicitação no seu sistema.

Até 100 caracteres.Aceita: null.

contactobject

Contato de quem pediu o atendimento.

Campos de contact
emailstring
phonestring
customerobject

Cliente vinculado. Só é gravado na criação.

Campos de customer
idstring
serviceobject

Tipo de OS vinculado. Só é gravado na criação.

Campos de service
idstring
locationobject

Localização do cliente, que precisa ser do cliente informado.

Campos de location
idstring
productslista de objetos

Produtos pedidos. Só é considerado na criação.

Campos de products
quantitynumberobrigatório
productobjectobrigatório
Campos de product
idstringobrigatório
serviceslista de objetos

Serviços pedidos. Só é considerado na criação.

Campos de services
quantitynumberobrigatório
serviceobjectobrigatório
Campos de service
idstringobrigatório
scheduleSuggestionslista de objetos

Sugestões de data e horário para o atendimento. Só é considerado na criação.

Campos de scheduleSuggestions
datestring

Data (AAAA-MM-DD).

timestring

Horário (HH:MM:SS).

contractorobject

Empresa contratante, para solicitações abertas em nome de terceiros. Só é considerado na criação.

Campos de contractor
namestringobrigatório
logoUrlstringobrigatório
sourcestringobrigatório
waypointslista de objetos

Pontos do trajeto, com kmTotal, para solicitações de deslocamento. Só é considerado na criação.

Campos de waypoints
latitudenumberobrigatório
longitudenumberobrigatório
kmTotalnumber

Distância total do trajeto, em km.

routeslista de objetos

Endereços do trajeto, na ordem de position. Só é considerado na criação, junto com waypoints e kmTotal.

Campos de routes
positionnumberobrigatório
postalCodestringobrigatório
streetstringobrigatório
numberstring

Aceita: null.

complementstring

Aceita: null.

neighborhoodstringobrigatório
citystringobrigatório
statestringobrigatório
formattedAddressstringobrigatório
countrystringobrigatório
placeNamestring

Aceita: null.

placePhonestring

Aceita: null.

latitudenumberobrigatório
longitudenumberobrigatório

Respostas

  • 200

    Solicitação 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): name ou message ausentes, # no número, ou localização que não é do cliente. Um identificador inválido ou de outra conta na URL também retorna este erro, com property: '@.id'.

  • 429

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

  • 500

    Erro inesperado no servidor.