●

Acesso Automatizado por Sistemas Externos

O Portal Institucional do TJBA possibilita o acesso automatizado por sistemas externos (ex: webservices ou api) em formatos abertos, estruturados e legíveis por máquinas.

A API disponibilizada permite o acesso a informações como comarcas, entrâncias e unidades.

URL: https://sojws.tjba.jus.br/graphql/

Instruções:

Listar Comarca

Descrição

Serviço para retornar lista de comarcas do TJBA e seus atributos.

Operação

listarComarca ()

O serviço espera um ComarcaFilter para utilizar como WHERE do SQL.

Parâmetros passados para o método:

Request

ATRIBUTOS	TIPO	TAMANHO	OBRIG.	DESCRIÇÃO
Id	NÚMERO	4	SIM	Id da comarca ou null (retornará todos os ids)
nmComarca	STRING	–	SIM	Nome da Comarca ou null (retorna todos os nomes)

Response

DADOS DE RETORNO
ATRIBUTOS	DESCRIÇÃO	OPCIONAL
Id	Id da comarca	SIM
idCircunscricao	Id da circunscrição	SIM
nomeComarca	Nome da comarca	SIM
cdStatus	Código do status (“I” Inativo ou “A” Ativo)	SIM
dtInstalacao	Data de Instalação	SIM
dtExtincao	Data de Extinção	SIM
nomeUsuarioUltimaAlteracao	Login do usuário que realizou a última alteração	SIM
dtaUltimaAlteracao	Data da última operação	SIM
idComarcaSede	Id da comarca sede	SIM
idMunicipio	Id do município	SIM
idUltEntrancia	Id da última entrância	SIM
cdCnj	Código do CNJ	SIM
idUnidadeSede	Id unidade sede	SIM
dtExclusao	Data da exclusão	SIM
cdUsuarioExclusao	Código do usuário de exclusão	SIM
flJurisdicaoPlena	Flag referente a Jurisdição plena	SIM

Exemplos:

Instrução GraphQL para utilizar o serviço. De acordo aos atributos :

Listar todas as Comarcas:
query{
listarComarca(comarcaFilter:{idComarca:null, nmComarca:null}) {
id,
nomeComarca
}
}

Listar Comarca pelo id:
O Id da comarca tem que ser digitado completo:
Exemplo com ID: listarComarca(comarcaFilter:{idComarca:6324, nmComarca:null}) {
id,
nomeComarca
}

Listar Comarca pelo nome:
O nome da comarca por ser passado de forma parcial:
Exemplo com Nome: listarComarca(comarcaFilter:{idComarca:null, nmComarca:”AMAR”}){
id,
nomeComarca
}

Imagem de Exemplo extraída da consulta via Postman.

Acesso Automatizado por Sistemas Externos

Listar Unidade

Descrição

Serviço para retornar todos os cartórios judiciais cadastrados com paginação dos resultados.

Operação

listarUnidade ()

O serviço espera um ComarcaFilter para utilizar como WHERE do SQL.

Parâmetros passados para o método:

Request:

ATRIBUTOS	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
página	Int	4	Sim	Número da página
codCns	Int	4	Não	Código CNS
nomeCartorio	String	100	Não	Nome do cartório
codMunicipio	Int	4	Não	Código do município do endereço do cartório
codComarca	Int	4	Não	Código de identificação da comarca
tipo	String	12	Não	Tipo de cartório = “Judicial”
status	Bool	1	Não	Indica se o cartório está ou não ativo. True = Ativo, False = Inativo
size	int	5	Sim	Tamanho de registros por página

Response:

ATRIBUTOS	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
codCns	Int	4	Sim	Código CNS
id	Int	4	Sim	Código do cartório
nomeCartorio	String	100	Sim	Razão Social do Cartório
codMunicipio	Int	4	Sim	Código de identificação do município do endereço do cartório
nomeMunicipio	String	100	Sim	Nome do Município do endereço do cartório
codComarca	Int	4	Sim	Código de identificação da comarca
nomeComarca	Int	60	Sim	Nome da comarca onde está vinculado o cartório
tipo	String	12	Sim	Tipo de cartório = “ExtraJudicial”
status	Bool	1	Sim	Indica se o cartório está ou não ativo. True = Ativo, False = Inativo
descrição	String	100	Sim	Nome do cartório
razaoSocial	String	100	Sim	Razão Social do cartório
email	String	100	Sim	Email do cartório
telefone	String	14	Sim	Telefone do cartório
comarca	String	50	sim	Nome da Comarca
codTipo	int	4	Sim
entrancia	String	50	Sim	Nome da entrância
cep	String	10	Sim	Cep do endereço do cartório
bairro	String	50	Sim	Bairro do endereço do cartório
logradouro	String	100	Sim	Logradouro do endereço do cartório
numero	String	5	Sim	Número do endereço do cartório
complemento	String	100	Sim	Complemento do endereço do cartório
codDistrito	int	4	Sim	Código do distrito do cartório
distrito	String	50	Sim	Nome do distrito do cartório
municipio	String	100	Sim	Nome do município do cartório
codEntrancia	int	4	Sim	Código da Entrância

Exemplos:

Instrução GraphQL para utilizar o serviço. De acordo aos atributos :

query listarUnidade {
    listarUnidade(
        unidadeFilter: {
            codCns: null
            nomeCartorio: null
            codMunicipio: null
            codComarca: null
            tipo: null
            status: null
            pagina: 1
            size: 5
        }
    ) {
        id
        codCns
        nomeCartorio
        codMunicipio
        nomeMuncipio
        codComarca
        nomeComarca
        tipo
        status
        descricao
        razaoSocial
        email
        telefone
        comarca
        codTipo
        entrancia
        cep
        bairro
        logradouro
        numero
        complemento
        codDistrito
        distrito
        municipio
        codEntrancia
    }
}

Imagem de Exemplo extraída da consulta via Postman.

Listar Entrâncias

Descrição

Serviço para retornar todas as entrâncias cadastradas

Operação

BuscarTodasEntrancias ()

Parâmetros passados para o método:

Request:

Não se aplica.

Response

ATRIBUTOS	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
Código	Int	4	Sim	Código da Entrância
Nome	String	50	Sim	Nome da Entrância

Exemplo:

query buscarTodasEntrancias {
    buscarTodasEntrancias {
        id
        nome
    }
}

Imagem de Exemplo extraída da consulta via Postman.

Listar Comarcas pela Entrância

Descrição

Serviço para retornar todas as comarcas cadastradas passando o código da entrância.

Operação

BuscarComarcaByEntrancia ()

O serviço espera um entranciaFilter para utilizar como WHERE do SQL.

Parâmetros passados para o método:

Request:

DADOS DE RETORNO
ATRIBUTOS	Tipo	Tamanho	Obrigatório	Descrição
IdEntrancia	Int	10	Sim	Código da Entrância

Response

DADOS DE RETORNO
ATRIBUTOS	Tipo	Tamanho	Obrigatório	Descrição
Id	Long	10	Sim	Código da Comarca
nome	String	100	Sim	Nome da Comarca

Exemplo:

No exemplo abaxo, o código 79 corresponde a Entrância Final. Este código pode ser obitido utilizando a consulta do método “Listar Entrâncias“.

query BuscarComarcaByEntrancia {

buscarComarcaByEntrancia(entranciaFilter: { idEntrancia: 79 }) {

id
idCircunscricao
nomeComarca
cdStatus
dtInstalacao
dtExtincao
nomeUsuarioUltimaAlteracao
dtaUltimaAlteracao
idComarcaSede
idMunicipio
idUltEntrancia
cdCnj
idUnidadeSede
dtExclusao
cdUsuarioExclusao
flJurisdicaoPlena

}

Imagem de Exemplo extraída da consulta via Postman.

Documentação completa Baixar