Consultar itens da lista

URN

/lista/item/listar

Método:

POST

Headers

{
    "Content-Type":"application/json",
    "Authorization": "Token XXXXXXXXXXXXXXXX"
}

Body:

{
    "it_lista": 2322,
    "filtros": {
        "Nome": "%ROB%LI%"
    }
}

Retorno:

{
    "msg": "Consulta realizada com sucesso",
    "status": "success",
    "erroNum": null,
    "data": [
        {
            "sr_id": 382665852,
            "campos": {
                "Nome": "ROBERTO DE LIMA",
                "Endereço": "",
                "Controle": "6"
            }
        },
        {
            "sr_id": 382665853,
            "campos": {
                "Nome": "ROBERTO DE LIMA",
                "Endereço": "",
                "Controle": "7"
            }
        },
        {
            "sr_id": 382665854,
            "campos": {
                "Nome": "ROBERTO DE LIMA",
                "Endereço": "",
                "Controle": "9"
            }
        }
    ]
}

Chave "it_lista" (Obrigatório)

Deve ser enviado o ID da lista que o usuário deseja utilizar.

Exemplo:

{
    "it_lista": 2322
}

Chave "filtros"

Não é obrigatória, mas, quando enviada, deve ser um objeto contendo o nome do item a ser filtrado e o valor desejado para o filtro. Pode-se utilizar o caractere % como coringa, semelhante ao funcionamento em bancos de dados.

Exemplo:

"filtros": {
    "Nome": "%ROB%LI%"
}

Caso o nome do item não corresponda a algum nome da lista, um erro será retornado.

Exemplo de erro:

{
    "msg": "A chave \"Nomes\" não existe nesta lista e não pode ser utilizada como filtro",
    "status": "error",
    "erroNum": "LIS-00005",
    "data": []
}