[API] Consultas básicas / Consultas tipo

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:

{
    "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:

{
    "tipoConsulta": [
        {
            "chaveTipo": "unidade-organizacional",
            "paginacaoTiposConsulta": "NAO_POSSUI",
            "filtroTiposConsulta": []
        },
        {
            "chaveTipo": "andamento-tipo",
            "paginacaoTiposConsulta": "NAO_POSSUI",
            "filtroTiposConsulta": [
                {
                    "filtro": "chaveModulo",
                    "valorDefaultFiltro": null,
                    "filtroObrigatorio": true
                }
            ]
        }
    ]
}

Exemplo de consultas

urlDeAcesso(?\|&)chave-tipo=centro-custo;tipo-conta;processo-justica;usuario;justica-extraJudicial;processo-situacao;atendimento-situacao;conta;processoVaraNumero;telefone-tipo;tipo-endereco;processoTipoParticipacao;unidade-organizacional;usuario-cargo;funcao;processoArea;andamento-tipo;arquivo-tipo;tarefa-fila-trabalho;pagamento-condicao-tipo;tipo-documento-financeiro;correcao-monetaria-tipo;perfil;processo-vara-tipo;permissao;processo-orgao-judicial;apontamento-hora-tipo;grupo;banco;cidade-estrangeira;processo-contingencia-tipo;pessoa;justica-cnj;arquivo-extensao-tipo;processo-relacionado-tipo;modulo-tarefa;conta-cartao-bandeira;tarefa-tipo;processoFase;processo-risco-tipo;email-tipo;cidade;estado-estrangeiro;processo-orgao-extra-judicial;estadosBrasil urlDeAcesso(?\|&)chave-tipo=centro-custo;tipo-conta urlDeAcesso(?\|&)chave-tipo=tipo-conta;processo-justica urlDeAcesso(?\|&)chave-tipo=processo-justica;usuario urlDeAcesso(?\|&)chave-tipo=usuario;justica-extraJudicial urlDeAcesso(?\|&)chave-tipo=justica-extraJudicial;processo-situacao urlDeAcesso(?\|&)chave-tipo=processo-situacao;atendimento-situacao urlDeAcesso(?\|&)chave-tipo=atendimento-situacao;conta urlDeAcesso(?\|&)chave-tipo=conta;processoVaraNumero urlDeAcesso(?\|&)chave-tipo=processoVaraNumero;telefone-tipo urlDeAcesso(?\|&)chave-tipo=telefone-tipo;tipo-endereco urlDeAcesso(?\|&)chave-tipo=tipo-endereco;unidade-organizacional urlDeAcesso(?\|&)chave-tipo=unidade-organizacional;usuario-cargo urlDeAcesso(?\|&)chave-tipo=usuario-cargo;funcao urlDeAcesso(?\|&)chave-tipo=funcao;processoArea urlDeAcesso(?\|&)chave-tipo=processoArea;andamento-tipo urlDeAcesso(?\|&)chave-tipo=andamento-tipo;arquivo-tipo urlDeAcesso(?\|&)chave-tipo=arquivo-tipo;tarefa-fila-trabalho urlDeAcesso(?\|&)chave-tipo=tarefa-fila-trabalho;pagamento-condicao-tipo urlDeAcesso(?\|&)chave-tipo=pagamento-condicao-tipo;tipo-documento-financeiro urlDeAcesso(?\|&)chave-tipo=tipo-documento-financeiro;correcao-monetaria-tipo urlDeAcesso(?\|&)chave-tipo=correcao-monetaria-tipo;perfil urlDeAcesso(?\|&)chave-tipo=perfil;processo-vara-tipo urlDeAcesso(?\|&)chave-tipo=processo-vara-tipo;permissao urlDeAcesso(?\|&)chave-tipo=permissao;apontamento-hora-tipo urlDeAcesso(?\|&)chave-tipo=apontamento-hora-tipo;grupo urlDeAcesso(?\|&)chave-tipo=grupo;banco urlDeAcesso(?\|&)chave-tipo=banco;cidade-estrangeira urlDeAcesso(?\|&)chave-tipo=cidade-estrangeira;processo-contingencia-tipo urlDeAcesso(?\|&)chave-tipo=processo-contingencia-tipo;pessoa urlDeAcesso(?\|&)chave-tipo=pessoa;justica-cnj urlDeAcesso(?\|&)chave-tipo=justica-cnj;arquivo-extensao-tipo urlDeAcesso(?\|&)chave-tipo=arquivo-extensao-tipo;modulo-tarefa urlDeAcesso(?\|&)chave-tipo=modulo-tarefa;conta-cartao-bandeira urlDeAcesso(?\|&)chave-tipo=conta-cartao-bandeira;tarefa-tipo urlDeAcesso(?\|&)chave-tipo=tarefa-tipo;processoFase urlDeAcesso(?\|&)chave-tipo=processoFase;processo-risco-tipo urlDeAcesso(?\|&)chave-tipo=processo-risco-tipo;email-tipo urlDeAcesso(?\|&)chave-tipo=email-tipo;cidade urlDeAcesso(?\|&)chave-tipo=cidade;estado-estrangeiro urlDeAcesso(?\|&)chave-tipo=estado-estrangeiro;processo-orgao-extra-judicial urlDeAcesso(?\|&)chave-tipo=processo-orgao-extra-judicial;estadosBrasil urlDeAcesso(?\|&)chave-tipo=estadosBrasil;estadosBrasil urlDeAcesso(?\|&)chave-tipo=processoArea(pagina:0$quantidadeRegistros:1) urlDeAcesso(?\|&)chave-tipo=usuario(nome:F) urlDeAcesso(?\|&)chave-tipo=justica-extraJudicial(processoTipo:F) urlDeAcesso(?\|&)chave-tipo=processoTipoParticipacao(participacaoTipo:TipoEnvolvidoType)
urlDeAcesso(?\|&)chave-tipo=funcao(nomeFuncao:F)
urlDeAcesso(?\|&)chave-tipo=processo-orgao-judicial(processoJusticaCodigo:F)
urlDeAcesso(?\|&)chave-tipo=processo-orgao-judicial(nomeOrgao:F)
urlDeAcesso(?\|&)chave-tipo=processo-orgao-judicial(processoJusticaCodigo:F$nomeOrgao:F)
urlDeAcesso(?\|&)chave-tipo=cidade-estrangeira(nome:F)
urlDeAcesso(?\|&)chave-tipo=pessoa(tipopessoa:F)
urlDeAcesso(?\|&)chave-tipo=pessoa(nome:F)
urlDeAcesso(?\|&)chave-tipo=pessoa(tipopessoa:F$nome:F)
urlDeAcesso(?\|&)chave-tipo=justica-cnj(processoTipo:F)
urlDeAcesso(?\|&)chave-tipo=processo-relacionado-tipo(relacionadoTipo:F)
urlDeAcesso(?\|&)chave-tipo=cidade(estado:F)
urlDeAcesso(?\|&)chave-tipo=cidade(cidade:F)
urlDeAcesso(?\|&)chave-tipo=cidade(estado:F$cidade:F)
urlDeAcesso(?\|&)chave-tipo=estado-estrangeiro(nome:F)
urlDeAcesso(?\|&)chave-tipo=processo-orgao-extra-judicial(nomeOrgao:F)
urlDeAcesso(?\|&)chave-tipo=estadosBrasil(codigoPais:F)
urlDeAcesso(?\|&)chave-tipo=estadosBrasil
urlDeAcesso(?\|&)chave-tipo=centro-custo
urlDeAcesso(?\|&)chave-tipo=tipo-conta
urlDeAcesso(?\|&)chave-tipo=processo-justica
urlDeAcesso(?\|&)chave-tipo=usuario
urlDeAcesso(?\|&)chave-tipo=justica-extraJudicial
urlDeAcesso(?\|&)chave-tipo=processo-situacao
urlDeAcesso(?\|&)chave-tipo=atendimento-situacao
urlDeAcesso(?\|&)chave-tipo=conta
urlDeAcesso(?\|&)chave-tipo=processoVaraNumero
urlDeAcesso(?\|&)chave-tipo=telefone-tipo
urlDeAcesso(?\|&)chave-tipo=tipo-endereco
urlDeAcesso(?\|&)chave-tipo=unidade-organizacional
urlDeAcesso(?\|&)chave-tipo=usuario-cargo
urlDeAcesso(?\|&)chave-tipo=funcao
urlDeAcesso(?\|&)chave-tipo=processoArea
urlDeAcesso(?\|&)chave-tipo=andamento-tipo
urlDeAcesso(?\|&)chave-tipo=arquivo-tipo
urlDeAcesso(?\|&)chave-tipo=tarefa-fila-trabalho
urlDeAcesso(?\|&)chave-tipo=pagamento-condicao-tipo
urlDeAcesso(?\|&)chave-tipo=tipo-documento-financeiro
urlDeAcesso(?\|&)chave-tipo=correcao-monetaria-tipo
urlDeAcesso(?\|&)chave-tipo=perfil
urlDeAcesso(?\|&)chave-tipo=processo-vara-tipo
urlDeAcesso(?\|&)chave-tipo=permissao
urlDeAcesso(?\|&)chave-tipo=apontamento-hora-tipo
urlDeAcesso(?\|&)chave-tipo=grupo
urlDeAcesso(?\|&)chave-tipo=banco
urlDeAcesso(?\|&)chave-tipo=cidade-estrangeira
urlDeAcesso(?\|&)chave-tipo=processo-contingencia-tipo
urlDeAcesso(?\|&)chave-tipo=pessoa
urlDeAcesso(?\|&)chave-tipo=justica-cnj
urlDeAcesso(?\|&)chave-tipo=arquivo-extensao-tipo
urlDeAcesso(?\|&)chave-tipo=modulo-tarefa
urlDeAcesso(?\|&)chave-tipo=conta-cartao-bandeira
urlDeAcesso(?\|&)chave-tipo=tarefa-tipo
urlDeAcesso(?\|&)chave-tipo=processoFase
urlDeAcesso(?\|&)chave-tipo=processo-risco-tipo
urlDeAcesso(?\|&)chave-tipo=email-tipo
urlDeAcesso(?\|&)chave-tipo=cidade
urlDeAcesso(?\|&)chave-tipo=estado-estrangeiro
urlDeAcesso(?\|&)chave-tipo=processo-orgao-extra-judicial
urlDeAcesso(?\|&)chave-tipo=pessoa(pagina:0$quantidadeRegistros:1)
urlDeAcesso(?\|&)chave-tipo=processo-orgao-extra-judicial(pagina:0$quantidadeRegistros:1)
urlDeAcesso(?\|&)chave-tipo=justica-extraJudicial(processoTipo:E)
urlDeAcesso(?\|&)chave-tipo=justica-cnj(processoTipo:J)