Descrição dos campos de chamada e retorno
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:
| Campo | Definição | Tipo | Campo obrigatório |
| tabela |
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. |
Integer | Sim |
| id |
ID do perfil a ser pesquisado nas tabelas OBS: Campo pode ser em lista. |
String | Não |
| limit | Máximo de itens a ser retornado por página. Default = 100 | Integer | Não |
| offset | Define a posição inicial da paginação. Default = 1 | Integer | Não |
Tabela de referência para o campo "success" e "message":
| Código | Sucess | Message | Descrição |
| 200 | Retorno com Sucesso |
OK |
Consulta realizada com sucesso |
| 400 | token_invalid | Bad Request | Token inválido |
| 400 | token_expired | Bad Request | Token expirado |
| 500 | internal_error | Internal server erro | Erro interno |
Descrição dos campos de retorno:
| Campo | Tipo | Formato | Descrição |
| message | String | Retorna se a consulta foi realizada com sucesso ou não | |
| tabela | String | Nome da tabela em que foi pesquisado | |
| recor_count | Integer | Quantidade de registros retornados | |
| id | Integer | ($int32) | ID do perfil pesquisado |
| descrição | String | Descrição do perfil pesquisado |