Pular para o conteúdo principal

Processo Rascunho

Explicação técnica da integração do Processo Rascunho

Este documento tem como objetivo, apresentar informações básicas e técnicas para auxiliar os tribunais na utilização dos serviços de integração do Processo Rascunho.

No PJe, antes de protocolar um processo é informado os dados do cumprimento de medida, e como o processo ainda não foi protocolado ele não tem o número, como isso foi gerado o serviço de "POST/api/v1/processo-rascunho" para salvar as informações no processo rascunho, quando o processo é protocolado o serviço salva os dados que estava no rascunho, é cadastrado o processo e o cumprimento de medida e logo após isso o processo o rascunho é excluído da base de dados.


A imagem abaixo é um demonstrativo dos serviços de integração do Processo Rascunho.

Model Processo RascunhoModel Processo Rascunho

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

Status CodeDescriçãoSituação
200OkRertorno de sucesso na execução
400Bad RequestIndica que a solicitação enviada ao servidor é inválida ou corrompida
401UnauthorizedIndica que as credenciais do usuário não foi autorizada ou a autenticação não são válidas
403ForbiddenIndica que um cliente está proibido de acessar a URL
404Not FoundIndica que o servidor não pode encontrar o recurso solicitado, por algum dado inválido
409ConflictIndica que a solicitação não pôde ser processada devido a um conflito na solicitação
500Internal server errorIndica, um problema geral com o servidor do site


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

GET/api/v1/processo-rascunho

Essa API permite que seja executado a consulta dos processos rascunhos passando alguns parametros obrigatórios, na execução se ocorrer sucesso o response retorna o status code 200 com a mensagem de"Requisição efetuada com sucesso." retornando a lista de todos os processos rascunhos.

Nesse serviço é permitido passar os parâmetros de pesquisa abaixo:

  1. AppName do Sistema do Tribunal
  2. Id-processo sistema externo

Se os parâmetros não forem informados, o serviço apresenta o status code 400 com a mensagem de obrigatoriedade, conforme imagem abaixo:

Model Processo RascunhoModel Processo Rascunho

POST/api/v1/processo-rascunho

Essa API quando executada passando todos os parâmetros correspondentes no JSON o serviço insere o processo rascunho na base de dados socioeducativa.

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

{
"appNameSistemaTribunal": "string",
"codigoMedidasSocioeducativas": [
"string"
],
"dataIngressoPrograma": "string",
"idProcessoSistemaExterno": "string",
"idUnidade": "string",
"situacaoCumprimento": "NAO_INFORMADO"
}

Ao expandir a API de POST será apresentado a coluna Model onde se explica os tipos de parâmetros que o JSON espera receber.

Model IntegracaoModel Integracao

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

  1. O parâmetro AppName do Sistema do Tribunal é obrigatório.
  2. O parâmetro id-processo sistema externo é obrigatório".
  3. O parâmetro com a lista de códigos da medida socioeducativa é obrigatório.
  4. O parâmetro dataIngressoPrograma passa ser obrigatório se o parâmetro situacaoCumprimento for igual a EM_CUMPRIMENTO

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."