Criar um equipamento

POSThttps://carchost.fieldcontrol.com.br/equipments

Cria um equipamento de um cliente (customer) ou guardado em um estoque (storage), já com as respostas dos campos customizados.

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

Requisição

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 do equipamento.

De 5 a 150 caracteres.

numberstringobrigatório

Número de série. Deve ser único na conta.

De 1 a 150 caracteres.

notesstring

Observações do equipamento.

Até 500 caracteres.Aceita: null.

qrCodestring

Código QR. Deve ser único na conta. Até 150 caracteres, ou 255 quando é uma URL de QR code público do Field Control (contém /qrcode-publico/#/ ou /equipamentos/gerador-qrcodes/#/).

Aceita: null.

avatarUrlstring

URL da foto do equipamento.

Até 150 caracteres.Aceita: null.

archivedboolean

Arquiva o equipamento.

Padrão: false.

typeobjectobrigatório

Tipo do equipamento, por id ou por name (nome exato). Se os dois forem enviados, vale o id.

Campos de type

idstring

Identificador do tipo de equipamento.

namestring

Nome do tipo de equipamento.

De 5 a 150 caracteres.

customerobject

Cliente dono do equipamento, por id ou por name (nome exato). Se os dois forem enviados, vale o id.

Campos de customer

idstring

Identificador do cliente.

namestring

Nome do cliente.

De 5 a 150 caracteres.

locationobject

Localização do cliente onde o equipamento está.

Campos de location

idstringobrigatório

Identificador da localização.

storageobject

Estoque onde o equipamento está guardado.

Campos de storage

idstringobrigatório

Identificador do estoque.

customFieldslista de objetos

Respostas dos campos customizados do tipo de equipamento. Na atualização, quando enviado, substitui todas as respostas atuais.

Um campo com condição de exibição (configurada no Painel do Gestor) só é exibido quando o gatilho tem a resposta esperada entre as respostas enviadas. Responder um campo oculto retorna 422 (hidden by condition), e um campo obrigatório com condição que fica visível sem resposta retorna 422 (required).

Campos de customFields

namestringobrigatório

Nome do campo, igual ao cadastrado no tipo de equipamento.

De 5 a 150 caracteres.

valuestringobrigatório

Resposta. Em multiple-choice, deve ser uma das opções cadastradas.

De 1 a 500 caracteres.

typestringobrigatório

Tipo do campo.

Valores aceitos: question, date, multiple-choice, number.

positionstring

Posição de exibição.

Até 150 caracteres.Aceita: null.

Respostas

• 201

  Equipamento criado. A resposta não inclui labels nem status.

• 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

  Corpo inválido (resourceValidationErr): customer e storage ausentes, number ou qrCode já usados na conta (reason: duplicated), tipo ou cliente não encontrados pelo nome (reason: not found), ou resposta de campo customizado com nome, tipo ou opção inexistentes.

• 429

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

• 500

  Erro inesperado no servidor.