Sistemas Tribunal

Explicação técnica da integração de Sistemas Tribunal

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 de Sistema Tribunal na PSE. Após a execução do serviço de tribunal para a base da PSE, é gerado a integração dos sistemas tribunais.

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

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/sistemas;
• POST/api/v1/tribunais/sistemas;
• PUT/api/v1/tribunais/sistemas;
• GET/api/v1/tribunais/sistemas/{id};
• DELETE/api/v1/tribunais/sistemas/{id};

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 sistema tribunal na base de dados da PSE.

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

{
 "appName": "string",
  "codigoTr": "string",
  "grauJustica": "NAO_APLICADO",
  "nomeSistemaEspecialista": "string",
  "nomeTribunal": "string",
  "segmentoPoderJudiciario": "NAO_DEFINIDO",
  "siglaTribunal": "string",
  "url": "string"
}

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

1. O parâmetro 'appName' precisa ser informado e deve ser único na base da PSE.
2. O parâmetro 'codigoTr' precisa ser informado, esse parâemtro é o vínculo do tribunal, por isso ele deve existir na base da PSE.
3. O parâmetro 'grauJustica' pode ser passado uma das tres opções abaixo:
• NAO_APLICADO.
• PRIMEIRO_GRAU.
• SEGUNDO_GRAU.
4. O parâmetro 'nomeSistemaEspecialista' deve ser informado.
5. O parâmetro 'nomeTribunal' deve ser o nome referente ao parâmetrocodigoTr informado.
6. O parâmetro 'segmentoPoderJudiciario' deve ser informado uma das opções contidas na lista que pode ser visualizada na aba Model
7. O parâmetro 'siglaTribunal' deve ser o nome referente ao parâmetrocodigoTr informado.
8. O parâmetro 'url' deve 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."

PUT/api/v1/tribunais/sistemas

Essa API permite que seja possível alterar informações do sistema tribunal.

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

{
 "appName": "string",
  "grauJustica": "NAO_APLICADO",
  "idSistemaTribunal": 0,
  "nomeSistemaEspecialista": "string",
  "segmentoPoderJudiciario": "NAO_DEFINIDO",
  "url": "string"
}

Para o serviço executar a alteração das informações do sistema tribunal, deve ser informado um idSistemaTribunal válido, ativo e existente na base da PSE.

GET/api/v1/tribunais/sistemas/{id}

Essa API permite executar a consulta por sistema tribunais passando o parâmetro id do sistema tribunal como um valor obrigatório.
Se for informado um id que não existe na base da PSE o response retorna o status code 400 com a mensagem "Recurso não encontrado".
Se for informado um id que existe na base da PSE o response retorna o status code 200 com a mensagem "Operação realizada com sucesso." e apresenta as informações do sistema tribunal.

DELETE/api/v1/tribunais/sistemas/{id}

Esse serviço quando executado permite a exclusão do sistema tribunal da base da PSE.
Para sucesso na exclusão basta informar o parâmetro id do sistema tribunal existente na base da PSE.

Após informado e o serviço executado, o response retorna o status code 200 e apresenta a mensagem "Operação realizada com sucesso."