Tribunal

Explicação técnica da integração de Tribunais

Este documento tem como objetivo, apresentar informações básicas e técnicas para auxiliar os tribunais na utilização dos serviços da integração dos Tribunais, Jurisdições e Órgãos na PSE.

Toda a Integração da PSE se resume por tribunais, ou seja, todos os dados integrados são correspondentes ao tribunal em específico.

A imagem abaixo é um demonstrativo dos serviços de integração dos Tribunais.

Na execução de cada uma das APIs o response deve retornar um dos Status Code abaixo correspondente ao status da execução.

Status Code	Descrição	Situação
200	Ok	Rertorno de sucesso na execução
400	Bad Request	Indica que a solicitação enviada ao servidor é inválida ou corrompida
401	Unauthorized	Indica que as credenciais do usuário não foi autorizada ou a autenticação não são válidas
403	Forbidden	Indica que um cliente está proibido de acessar a URL
404	Not Found	Indica que o servidor não pode encontrar o recurso solicitado, por algum dado inválido
409	Conflict	Indica que a solicitação não pôde ser processada devido a um conflito na solicitação
500	Internal server error	Indica, um problema geral com o servidor do site

Abaixo segue o link onde será melhor explicado as regras de execução.

• GET/api/v1/tribunais;
• POST/api/v1/tribunais;
• GET/api/v1/tribunais/{id};
• POST/api/v1/tribunais/{id}/jurisdicoes;
• GET/api/v1/tribunais/{idTribunal}/jurisdicoes;
• GET/api/v1/tribunais/{idTribunal}/jurisdicoes/{idJurisdicao}/orgaos;
• POST/api/v1/tribunais/{idTribunal}/jurisdicoes/{idJurisdicao}/orgaos;
• GET/api/v1/tribunais/{idTribunal}/orgaos;
• GET/api/v1/tribunais/tr/{tr};

GET/api/v1/tribunais

Essa API permite que seja executado a consulta dos tribunais sem a necessidade de informar parametros de pesquisa, na execução se ocorrer sucesso o response retorna o status code 200 com a mensagem de"Operação realizada com sucesso." retornando a lista de todos os tribunais da base de dados da PSE.

POST/api/v1/tribunais

Essa API quando executada passando todos os parâmetros correspondentes no JSON o serviço insere o tribunais na base de dados da PSE.

O serviço espera os parâmetros abaixo para execução:

{
  "nome": "",
  "sigla": "",
  "tr": ""
}

Para realizar a integração o serviço valida o nome do tribunal passado no parâmetro Nome se ele existe no CNJ, e os parâmetros TR e Sigla devem estar de acordo com o nome do tribunal informado. Se não estiverem em acordo o serviço não é executado e o response apresenta a mensagem "O nome do tribunal está divergente da sigla e do TR informado."

1. O parâmetro 'Nome' precisa ser informado
2. O parâmetro 'Sigla' precisa ser informada.
3. O parâmetro 'TR' precisa ser informado

Após informado os dados obrigatório e executado o serviço, o response retorna o status code 200 com a mensagem "Requisição efetuado com sucesso."

GET/api/v1/tribunais/{id}

Essa API permite que seja executado a consulta dos tribunais passando o parâmetro obrigatório "id" do tribunal, na execução se ocorrer sucesso o response retorna o status code 200 com a mensagem de "Operação realizada com sucesso." retornando as informações do tribunal.

POST/api/v1/tribunais/{id}/jurisdicoes

Essa API permite inserir uma jurisdição ao tribunal, essa jurisdição são os Fóruns vinculados aos tribunais cadastrados.

O serviço espera os parâmetros abaixo para execução:

{
  "codigoOrigem": "string",
  "nome": "string"
}

Para a execução do serviço, deve seguir as seguintes regras:

Para realizar a integração, é necessário informar o código do tribunal válido e existente na PSE.
Os parâmetros abaixo são obrigatórios na execução do serviço.

1. O parâmetro 'Código Origem' deve conter apenas números."
2. O parâmetro 'Nome' precisa ser informado".
3. O parâmetro 'Id' precisa ser informado

Após informados todos os parâmetros obrigatórios o serviço é executado com sucesso vinculando um Fórum ao tribunal.

GET/api/v1/tribunais/{idTribunal}/jurisdicoes

Esse serviço permite executar realizar a consulta de jurisdições vinculadas ao tribunal.

Para execução do serviço podem ser passados os parâmetros abaixo, onde o parâmetro idTribunal deve ser obrigatório.

1. Id Origem.
2. Nome da Jurisdição.
3. Id do Tribunal

Após informado o(s) parêmtros, se tiver informação referente ao id do tribunal, o response retorna o status code 200 com a mensagem "Operação realizada com sucesso." e apresenta a lista de jurisdições vinculadas ao tribunal.

GET/api/v1/tribunais/{idTribunal}/jurisdicoes/{idJurisdicao}/orgaos

Esse serviço permite realizar a consulta de jurisdições e tribunais para saber qual o órgão está vinculado a eles.

Para execução do serviço deve ser passados os parâmetros abaixo.

1. Id Jurisdição.
2. Id do Tribunal.

Após informar os parâmetros, e a consulta realizada o response retorna a lista contendo as informações do Tribunal, Jurisdição e o nome do Órgão vinculado.

POST/api/v1/tribunais/{idTribunal}/jurisdicoes/{idJurisdicao}/orgaos

Esse serviço permite inserir o vínculo de Órgão com a Jurisdição e o Tribunal, para execução com sucesso deve ser passado os parâmetros abaixo:

Para a execução do serviço, deve seguir as seguintes regras:

1. Nome do Órgão.
2. Id Jurisdição. Se for informado um id jurisdição não existente na PSE, o serviço não é executado e retorna a mensagem "Nenhuma Jurisdição encontrada.".
3. Id do Tribunal. Se for informado um id tribunal não existente na PSE, o serviço não é executado e retorna a mensagem "Tribunal não encontrado na base da Plataforma Socioeducativa com o 'id' informado.".

Após informar os parâmetros e executar o serviço, o response retorna a lista contendo as informações do Tribunal, Jurisdição e o nome do Órgão vinculado.

GET/api/v1/tribunais/{idTribunal}/orgaos

Esse serviço permite a execução da consulta de órgão por id do tribunal.

Esse serviço permite que seja passado os parâmetros abaixo:

1. Código Origem que faz parte da jurisdição.
2. Mome da Jurisdição.
3. Nome do Órgão
4. Id do tribunal que nesse serviço é um parâmetro obrigatório

Após informado os parâmetros, se tiver informações na base da PSE o response retorna o status code 200 com a mensagem "Operação realizada com sucesso." e apresenta a lista de informações do Órgão e Jurisdição vinculado ao tribunal informado no parâmetro.

GET/api/v1/tribunais/tr/{tr}

Esse serviço permite a execução da consulta de tribunal informado como parâmetro obrigatório o "TR".

Após informado o parâmetro e a consulta realizada, o response retorna o status code 200 com a mensagem "Operação realizada com sucesso." e apresenta as informações do tribunal de acordo com o TR informado.