Pular para o conteúdo principal

Vincular um equipamento à ordem

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/equipments

Vincula a uma ordem de serviço um equipamento do mesmo cliente. Retorna o equipamento.

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.

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.

equipmentobjectobrigatório
Campos de equipment
idstringobrigatório

Identificador do equipamento. O equipamento precisa ser do mesmo cliente da ordem.

Respostas

  • 201

    Equipamento vinculado.

  • 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.

  • 409

    Equipamento já vinculado à ordem (resourceAlreadyExists).

  • 422

    Equipamento inexistente, de outro cliente (reason: different customers) ou identificador inválido (resourceValidationErr). 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.