Endpoint: Listando Avaliações de Checklist

Endpoint que permite a listagem das avaliações de checklist criadas na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1/checklist/avaliacao

Método: GET

A busca da lista de avaliações é paginada. O endpoint é limitado a 100 registros por página.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>
Content-Type	application/json;charset=UTF-8

Query parameters

Filtro	Valor	Descrição
start	Integer	Início da paginação (número da página). Padrão 0
limit	Integer	Número de registros por página. Máximo 100. Padrão 100
id	Integer	Código da Avaliação do Checklist
modeloId	Integer	Código do Modelo de Checklist
responsavelId	Integer	Código da pessoa responsável pela avaliação do Checklist
unidadeId	Integer	Código da empresa da avaliação do Checklist
situacao	Integer referente a situação da avaliação: 1 – Concluído 2 – Andamento 3 – Validação	Situação da avaliação do Checklist
dtFimStart	String	Data de término da avaliação do checklist. Busca as avaliações a partir da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2021-08-06T18:02:55Z
dtFimEnd	String	Data de término da avaliação do checklist. Busca as avaliações até a da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2021-08-06T18:02:55Z

Exemplo

fetch("https://api.sults.com.br/api/v1/checklist/avaliacao?dtFimStart=2022-01-01T03:00:00Z&dtFimEnd=2022-07-08T12:00:00Z", {
	method: "GET",
	headers: {
		"Authorization":"<token_de_acesso>",
		"Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
    "data": [
        {
            "id": 1201,
            "dtInicio": "2021-04-12T19:41:56Z",
            "dtFim": "2021-07-05T18:14:41Z",
            "dtCriacao": "2021-04-13T11:46:30Z",
            "dtPrazo": "2021-04-13T11:46:30Z",
            "pontuacaoAlcancada": 520.00,
            "pontuacaoAlcancadaZerada": false,
            "pontuacaoMaxima": 660.56,
            "permitidoAvaliacaoAntesDtPrazo": true,
            "modelo": {
                "id": 25,
                "nome": "Inspeção de Lojas - Qualidade"
            },
            "objeto": {
                "id": 19,
                "nome": "Objeto em avaliação"
            },
            "situacao": 3,
            "unidade": {
                "id": 138,
                "nomeFantasia": "Empresa Fantasia",
                "cnpj": "42274696002561"
            },
            "criacaoPessoa": {
                "id": 108,
                "nome": "User Teste"
            },
            "responsavel": {
                "id": 108,
                "nome": "User Teste"
            },
            "campanha": {
                "id":19,
                "nome": "Campanha Nome"
            },
            "checkinHabilitado": true,
            "checkoutHabilitado": true,
            "checkin": {
                "id": 130,
                "dtCheckin": "2022-04-12T19:41:03Z"
            },
            "checkout": {
                "id": 63,
                "dtCheckout": "2022-07-05T18:14:41Z"
            }
        }
    ],
    "start": 0,
    "limit": 100,
    "size": 1,
    "totalPage": 1
}

Campos da resposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código da avaliação do Checklist
dtInicio	String	Data em que a avaliação foi iniciado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
dtFim	String	Data em que a avaliação foi finalizada. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
dtCriacao	String	Data em que a avaliação foi criada. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
pontuacaoAlcancada	Decimal	Pontuação alcançada na avaliação do Checklist
pontuacaoAlcancadaZerada	Boolean	Booleano que indica que a pontuação da avaliação foi zerada
pontuacaoMaxima	Decimal	Pontuação máxima que pode ser obtida em uma avaliação
permitidoAvaliacaoAntesDtPrazo	Boolean	Permitido fazer a avaliação antes do prazo da avaliação
modelo	Objeto Modelo: – id – nome	Modelo de Checklist
objeto	Objeto Objeto: – id – nome	Objeto que será avaliado
responsavel	Objeto Pessoa	Pessoa responsável pela avaliação do Checklist
unidade	Objeto Unidade	Unidade da avaliação
criacaoPessoa	Objeto Pessoa	Pessoa que criou a avaliação
campanha	Objeto Campanha: – id – Nome	Campanha ao qual o Checklist pertence
checkinHabilitado	Booleano	Se true habilitado fazer checkin na avaliação.
checkoutHabilitado	Booleano	Se true habilitado fazer checkout na avaliação.
checkin	Objeto Checkin: – id – dtCheckin	Checkin da avaliação
checkout	Objeto Checkout: – id – dtCheckout	Checkout da avaliação

Campos do Objeto Pessoa

Nome Atributo	Tipo	Descrição
id	Integer	Código da Pessoa
nome	String	Nome da Pessoa

Campos do Objeto Unidade

Nome Atributo	Tipo	Descrição
id	Integer	Código da Unidade
nomeFantasia	String	Nome fantasia da Unidade
cnpj	String	CNPJ da Unidade