Pular para o conteúdo principal

Instalar uma unidade de peça

POSThttps://carchost.fieldcontrol.com.br/part-units/{id}/install

Instala a unidade em um equipamento ou localização. Se estava em estoque, a API registra uma movimentação de saída. Qualquer situação é aceita, exceto discarded.

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 unidade de peça.

Exemplo: YzNkNGU1ZjYtYTdiOC05MDEyLWNkZWYtMTIzNDU2Nzg5MDEyOjIyOTE1.

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.

equipmentIdstring

Equipamento em que a unidade é instalada.

locationIdstring

Localização em que a unidade é instalada.

locationSectorIdstring

Setor da localização.

locationEnvironmentIdstring

Ambiente da localização.

installedAtstring (data e hora)

Data de instalação. Padrão é o momento da requisição.

replacementDueAtstring (data e hora)

Data prevista para troca.

Respostas

  • 200

    Unidade instalada (status: installed).

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

  • 422

    Unidade descartada (reason: invalid status) ou equipamento, localização, setor ou ambiente inexistentes (resourceValidationErr). Unidade inexistente: 422 resourceNotFound (não há 404). Identificador da URL inválido ou de outra conta: uriValidationErr.

  • 429

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

  • 500

    Erro inesperado no servidor. Acontece também quando um identificador do corpo não está no formato esperado.