TnWebDMConsultaPegar

GET - /TnWebDMConsulta/Pegar

Retorna os dados de uma consulta do sistema.

Parâmetros

Parâmetro	Obrigatório	Tipo do Parâmetro	Descrição	Valores Válidos
tokenapi	Não	Texto	Token de validação do acesso. Se a base de dados possuir um token cadastrado passa a ser obrigatório informar o mesmo
_AActionName	Sim	Texto	Nome interno da consulta a ser acessada
_AiDisplayStart	Sim	Inteiro	Indica qual o primeiro registro que deve ser retornado	Valor maior ou igual a 0(zero)
_AiDisplayLength	Sim	Inteiro	Indica quantos registros deve retornar a partir do primeiro indicado no parâmetro _AiDisplayStart	Valor maior ou igual a 1(um)
_AOrderBy	Não	Inteiro	Indica qual coluna da consulta deve ser utilizada para ordenar os dados
_AsEcho	Sim	Texto	Indica a ordem dos dados da consulta	desc=Decrescente qualquer outro valor=Crescente

Body - Obrigatório

Informar no body um JSON contendo os valores de filtro que devem ser utilizados na consulta. O JSON deve conter um objeto "Filter" e cada propriedade do objeto deve corresponder a um campo da consulta.

Ex:

{"Filter":{"CODIGOEMPRESA":"1", "CODIGOESTAB":"1", "DATALCTOFIS":"02/01/2023..03/01/2023"}}

Irá filtrar a empresa 8, estabelecimento 1.

Respostas

Resposta

Conteúdo

200

Retorna um JSON com as informações das colunas(aoColumns e aoLabels) e com os dados da consulta(aaData). Ex:

{

"sEcho": "desc", "aoColumns": [

"CODIGOEMPRESA", "NOMEEMPRESA", "DATAENCERATIV"

"aoLabels": [

"Empresa", "Razão Social",

"Encerramento da Atividade"

"aaData": [

[

"9999",

"Empresa Padrão New Informática - S

efaz SC",

"31/12/2100"

]

"iTotalDisplayRecords": 1,

"RecordCount": 1, "additionalFilters": [

"ToolBtnInativo"

"additionalFiltersLabels": [ "Mostrar / Ocultar Inativos"

"additionalFiltersActive": [ "ToolBtnInativo"

"Message": ""

}

401

Acontece quando a base possui um token de validação que não foi repassado através do parâmetro "tokenapi" ou está incorreto. Ex:

{

"errorCode": 401,

"errorText": "Acesso negado, verifique o to ken informado."

}