Execuções

Nesta documentação, você encontrará todas as informações necessárias para listar explorar informações a respeito de execuções por meio de nossa API.

Autenticação

Antes de começar a utilizar os endpoints relacionados aos checklists, certifique-se de incluir as credenciais de autenticação adequadas no cabeçalho de suas solicitações. Sem autenticação válida, você não terá permissão para acessar, pesquisar ou modificar informações. Para ter acesso a documentação dessa etapa clique aqui

Listando o sumário das execuções ocorridas

Retorna os dados de sumário de uma execução especifica, através do ID.

GET

https://api.webrota.com.br/checklist/ID

Retorna os dados de sumário de todas as execuções, por meio de GET através de filtros.

GET

https://api.webrota.com.br/checklist/

Nome	Tipo	Obrigatório	Padrão	Descrição
date_time_start	Data e hora	Sim		Data inicio do periodo para busca de execução
date_time_end	Data e hora	Sim		Data de término do período de busca desejado no formato
checklist_code	Inteiro	Não		Código da execução do checklist
user_ids	Coleção	Não		Relação de identificadores de agentes executores
includes	Coleção	Não	user,checklist_form	Relação de identificadores de agentes executores

Exemplo de resposta

{
    "data": [
        {
            "longitude": -47.123,
            "latitude": -22.123,
            "count_items": 123,
            "user_id": 123,
            "id": 123,
            "count_high_risk": 4,
            "checklist_form": {
                "id": 123,
                "name": "Checklist",
                "icon": "fa-edit"
            },
            "receipt_email": "",
            "checklist_form_id": 123,
            "date_executed": "2023-06-23T09:31:11+00:00",
            "identifier_fields": [
                {
                    "value": "Valor 1",
                    "form_field_id": 123,
                    "form_field_name": "Item identificador 1"
                },
                {
                    "value": "Valor 2",
                    "form_field_id": 123,
                    "form_field_name": "Item identificador 2"
                }
            ],
            "count_low_risk": 0,
            "count_medium_risk": 0,
            "date_created": "2023-06-23T09:31:13+00:00",
            "user": {
                "id": 123,
                "name": "Agente especial"
            },
            "customer_id": 123,
            "signature": "HASH-IMAGEM",
            "executed": [],
        }
    ]
}

Obtendo detalhes de uma execução

Retorna os detalhes de uma execução específica com base em seu ID, por meio de GET, incluindo informações a respeito do que foi informado em cada campo de preenchimento < CheckListFormField >.

GET

https://api.webrota.com.br/checklist_form_field_executed/

Nome	Tipo	Obrigatório	Padrão
includes	Coleção	Sim	checklist_form_field checklist_form_field.table checklist_form_field.table.items
id	Inteiro	Sim

Exemplo de resposta

{
    "data": [
        {
            "id": 123,
            "risk_level": "H",
            "picture": "HASH-IMAGEM.jpeg",
            "checklist_id": 123,
            "value": "Valor informado",
            "checklist_form_field": {
                "id": 123,
                "name": "Item 1",
                "type": "1",
                "order": 0,
                "can_photo": 1,
                "table": {
                    "id": 123,
                    "customer_id": 123,
                    "items": [
                        {
                            "id": 123,
                            "name": "Bom",
                            "risk_level": "L"
                        },
                        {
                            "id": 123,
                            "name": "Mediano",
                            "risk_level": "L"
                        },
                    ],
                    "name": "Bom/ruim/mediano",
                    "date_created": "2022-12-23T11:34:53+00:00",
                },
                "can_additional_data": 1
            }
        },
    ]
}

Obter imagens do checklist

Para ter acesso ao Base64 dos arquivos de imagem utilize o endpoint abaixo.

GET

https://api.webrota.com.br/checklist/picture/

Nome	Tipo	Obrigatório	Padrão
picture	Texto	Sim	HASH do nome do arquivo