Criação de auto inspeções em lote

Introdução

Esse endpoint disponibiliza a funcionalidade de criar múltiplas auto inspeções com apenas uma requisição assíncronamente.

Cada auto inspeção enviada será inserida numa fila para processamento. Um webhook será disparado com informações sobre cada auto inspeção assim que ela for processada.

---

Utilização

• Para requisitar a criação em lote, envie uma array JSON para o endpoint abaixo onde cada entrada é um objeto contendo as informações listadas na tabela a seguir.

---

URL

POST :

https://autoinspecao-api.vexsoft.com.br/auto-inspecao/criar-em-lote

---

Request

Headers

Chave	Valor
Content-Type	application/json
Charset	UTF-8

Body

• O corpo da rquisição deve ser uma array JSON ([...]) onde cada entrada é um objeto ({key: value, ...}) contendo as seguintes informações:

Especificação

Campo	tipo	Descrição
token	string	Token da empresa ?
id_tipo_operacao	integer	ID de um tipo de operação ativo de auto inspeção ?
veiculo_placa	string	Placa do veículo
veiculo_tipo	integer	ID do questionario do veículo* ?
veiculo_nome	string	Modelo/marca do veículo
cliente_nome	string	Nome do cliente
cliente_email	string	E-mail do cliente
cliente_numero	string	Número de celular do cliente
criado_por	integer	ID do usuário que criou a auto inspeção ?
selecionar_galeria	'sim' | 'nao'	Verificação se o vistoriador poderá utilizar fotos da galeria para anexar na vistoria
enviar_para_usuario	'sim' | 'nao'	Se deverá (ou não) ser enviada uma cópia das mensagem de WhatsApp paras o usuário qeu criou a auto inspeção

Exemplo

[
    {
        "token": "AAA000",
        "veiculo_placa": "ABC1234",
        "id_tipo_operacao": 45,
        "veiculo_tipo": 19777,
        "veiculo_nome": "Corsa",
        "cliente_nome": "David",
        "cliente_email": "[email protected]",
        "cliente_numero": "44999999999",
        "criado_por": 24681,
        "selecionar_galeria": "sim",
        "enviar_para_usuario": "nao"
    },
    {
        "token": "AAA000",
        "veiculo_placa": "BBB0000",
        "id_tipo_operacao": 46,
        .
        .
        .
    },
    .
    .
    .
]

* O questionário utilizado deve estar habilitado para o tipo de operação utilizado

---

Response

Status	Descrição
200	Todas as auto inspeções foram adicionada à fila de processamento com sucesso
400	Corpo inválido ou sintaxe JSON inválida
422	Alguma auto inspeção na array contem dados inválidos ou conflitantes
500	Erro interno

Detalhes dos status

200

Corpo retornado

O corpo retornado será o mesmo array enviado na requisição, porém com cada entrada acrescida do campo contendo o hash gerado para a auto inspeção.

[
    {
        "hash": "abb279b4bf745390b79423fa72",
        "token": "AAA000",
        "veiculo_placa": "ABC1234",
        "id_tipo_operacao": 45,
        "veiculo_tipo": 19777,
        "veiculo_nome": "Corsa",
        "cliente_nome": "David",
        "cliente_email": "[email protected]",
        "cliente_numero": "44999999999",
        "criado_por": 24681,
        "selecionar_galeria": "sim",
        "enviar_para_usuario": "nao",
    },
    {
        "hash": "2480ab9b4bf74808babf8addf",
        "token": "AAA000",
        "veiculo_placa": "BBB0000",
        "id_tipo_operacao": 46,
        .
        .
        .
    },
    .
    .
    .
]

422

Corpo retornado

O corpo retornado é um JSON onde cada propriedade contém uma array de índices referentes a array enviada na requisição. Cada índice corresponde a uma entrada com erro na requisição:

{
    "entradas_repetidas": [0, 3, ...],
    "entradas_conflitantes": [...],           
    "entradas_dados_faltando": [...],
    "entradas_numero_invalido": [...],
    "entradas_questionario_invalido": [...],
    "entradas_tipo_operacao_invalido": [...]
}

Descrição das propriedades:

• entradas_repetidas: Entradas em que os dados conflitam com outras entradas na própria requisição (ex.: placa repetida com o parâmetro que bloqueia placas repetidas ativo na empresa)
• entradas_conflitantes: Entrada em que os dados entram em conflito com as auto inspeções já abertas no sistema
• entradas_dados_faltando: Entradas que possuem dados obrigatórios faltando
• entradas_numero_invalido: Entradas com número de celular inválido
• entradas_questionario_invalido: Entradas com ID de questionário inválido (questionário inexistente ou inativo)
• entradas_tipo_operacao_invalido: Entradas com ID de tipo de operação inválido (tipo inexistente ou inativo)

---

Pós-envio

Após os envio das auto inspeções a serem criadas por meio desse endpoint, o requisitante deve escutar o Webhook de auto inspeções para capturar os eventos de criação de auto inspeções, que irá conter o hash identificador da auto inspeção.