# Descrição dos campos de chamada e retorno

<main class="col-6" id="bkmrk-objetivo%3A%C2%A0identifica">**Objetivo:** Identificar o cliente ou parceiro ao enviar a consulta de acordo com autenticação.

**Descrição dos filtros que poderão ser utilizados na chamada:**

<div><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td>**Campo**</td><td>**Definição**</td><td>**Tipo**</td><td>**Campo obrigatório**</td></tr><tr><td>tabela</td><td>Indica a tabela onde será pesquisado o ID informado

1 = perfilOrigem

2 = perfilDestino

3 = Natureza

4 = Finalidade

OBS: Campo não pode ser em lista.

</td><td>Integer</td><td>Sim</td></tr><tr><td>id</td><td>ID do perfil a ser pesquisado nas tabelas

OBS: Campo pode ser em lista.

</td><td>String</td><td>Não</td></tr><tr><td>limit</td><td>Máximo de itens a ser retornado por página. Default = 100</td><td>Integer</td><td>Não</td></tr><tr><td>offset</td><td>Define a posição inicial da paginação. Default = 1</td><td>Integer</td><td>Não</td></tr></tbody></table>

</div>  
**Tabela de referência para o campo "success" e "message":**

<div><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td>**Código**</td><td>**Sucess**</td><td>**Message**</td><td>**Descrição**</td></tr><tr><td>200</td><td>Retorno com Sucesso</td><td>OK

</td><td>Consulta realizada com sucesso</td></tr><tr><td>400</td><td>token\_invalid</td><td>Bad Request</td><td>Token inválido</td></tr><tr><td>400</td><td>token\_expired</td><td>Bad Request</td><td>Token expirado</td></tr><tr><td>500</td><td>internal\_error</td><td>Internal server erro</td><td>Erro interno</td></tr></tbody></table>

</div>  
**Descrição dos campos de retorno:**

<div><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td>**Campo**</td><td>**Tipo**</td><td>**Formato**</td><td>**Descrição**</td></tr><tr><td>message</td><td>String</td><td> </td><td>Retorna se a consulta foi realizada com sucesso ou não</td></tr><tr><td>tabela</td><td>String</td><td> </td><td>Nome da tabela em que foi pesquisado</td></tr><tr><td>recor\_count</td><td>Integer</td><td> </td><td>Quantidade de registros retornados</td></tr><tr><td>id</td><td>Integer</td><td>($int32)</td><td>ID do perfil pesquisado</td></tr><tr><td>descrição</td><td>String</td><td> </td><td>Descrição do perfil pesquisado</td></tr></tbody></table>

</div><div>---

</div></main>