A consulta de tipos fornece uma interface genérica para diversos dados do sistema, bastando informar a chave do tipo conforme os exemplos abaixo:
...
URL: {URL_SERVICE}/adv-service/tipo?chave-tipo={CHAVE_TIPO}(pagina:{NUMERO_PAGINA}$quantidadeRegistros:{QUANTIDADE_REGISTROS})
Documentação Open API: https://docs.sajadv.com.br/resource_Comum.html#resource_Comum_consultarTiposQuery_GET
Método: Get
Exemplo de requisição:
URL: https://api.sajadv.com.br/adv-service/tipo?chave-tipo=todos-processo-relacionado-tipo
Exemplo de resposta:
| Bloco de código |
|---|
{
"consultaTipoRetorno": [
{
"chaveTipo": "todos-processo-relacionado-tipo",
"quantidadeRegistros": 2,
"simpleDto": [
{
"chave": 1,
"valor": "Agravo de instrumento"
},
{
"chave": 2,
"valor": "Agravo em Recurso Especial"
}
]
}
]
} |
...
Conforme podes observar no padrão da URL, é possível adicionar parâmetros de paginação como pagina e quantidadeRegistros:
URL:
Parâmetro chave-tipo:
Para obter os valores possíveis para "chave-tipo", consulte o endpoint https://api.sajadv.com.br/adv-service/tipo/chave, nele, você receberá uma resposta como:
| Bloco de código |
|---|
{
"tipoConsulta": [
{
"chaveTipo": "unidade-organizacional",
"paginacaoTiposConsulta": "NAO_POSSUI",
"filtroTiposConsulta": []
},
{
"chaveTipo": "andamento-tipo",
"paginacaoTiposConsulta": "NAO_POSSUI",
"filtroTiposConsulta": [
{
"filtro": "chaveModulo",
"valorDefaultFiltro": null,
"filtroObrigatorio": true
}
]
}
]
} |
...