Pular para o conteúdo principal

Processos

Explicação técnica da integração dos Processos

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 dos Processos que atualmente são compostos por dois tipos de processos:

  • Processo de Apuração de Ato Infracional
  • Processo de Execução de Medidas

Os Processos são separados por tribunais em acordo com o tribunal vinculado ao usuário que executar os serviços.

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

Model AdolescentesModel Adolescentes

Na execução de cada API 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/processos​

Essa API permite que seja executado a consulta de processos passando alguns parametros não 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.

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

  • Código do Tribunal
  • Identificador do Adolescente
  • Situação do Processo
  • Tipo do processo
  • Situação das Guias
    • Processo de Apuração de Ato Infracional
    • Execução de Medidas Socioeducativas

POST/api/v1/processos​

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

Nota: Por questões de segurança a API de POST de processos não é executada no Swagger, é executada somente no Postman através das configurações listradas abaixo.
No Postman na aba de Authorization deve ser passado os parâmetros abaixo para geração do token que permite a execução.

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

{
  "appNameSistemaTribunal": "string",
  "idOrgao": 0,
  "idProcessoSistemaExterno": "string",
  "identificadoresAdolescentes": [
    "string"
  ],
  "magistradoCPF": "string",
  "magistradoNome": "string",
  "numeroProcesso": "string",
  "numeroProcessoReferencia": "string",
  "serventuarioCPF": "string",
  "serventuarioNome": "string",
  "tipoProcesso": "PROCESSO_DE_APURACAO_DE_ATO_INFRACIONAL"
}

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

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

  1. O parâmetro appNameSistemaTribunal é obrigatório;
  2. O parâmetro idOrgao é obrigatório;
  3. O parâmetro idProcessoSistemaExterno é o id do retorno da execução do serviço de POST/api/v1/processo-rascunho;
  4. O parâmetro identificadoresAdolescentes é obrigatório e pode ser passado uma lista de identificadores;
  5. Se o tipo processo informado for EXECUCAO_DE_MEDIDAS_SOCIOEDUCATIVAS então o parâmetro numeroProcessoReferencia deve ser passado o número do processo do tipo PROCESSO_DE_APURACAO_DE_ATO_INFRACIONAL;
  6. Os parâmetros numeroProcessoReferencia e numeroProcesso tem que ter o padrão NNNNNNN-DD.AAAA.J.TR.0000 ou NNNNNNNDDAAAAJTR0000;
  7. Os parâmetros numeroProcesso deve ser único, se já estiver na base de dados é apresentado a trava que já existe na base de dados.

PUT/api/v1/processos​

Essa API quando executada passando todos os parâmetros correspondentes no JSON o serviço atualiza as informações do magistrado e serventuário do processo.
O serviço espera como parâmetros os campos abaixo para execução:
{
  "magistradoCPF": "string",
  "magistradoNome": "string",
  "numeroProcesso": "string",
  "serventuarioCPF": "string",
  "serventuarioNome": "string"
}

GET/api/v1/processos/{id}​

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

POST/api/v1/processos/{numeroProcesso}/apuracao/adolescentes/{identificadorAdolescente}​

Essa API permite a inclusão de mais adolescente no processo de Processo de Apuração de Ato Infracional.

Nesse serviço é obrigatório passar os parâmetros abaixo:

  • Identificador do Adolescente.
  • Número do Processo.

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

  1. O serviço será executado somente se o "Nº do processo" informado existir na base do Socioeducativo.
  2. O serviço será executado somente se o "Nº do processo" informado for do tipo "APURAÇÃO DE ATO INFRACIONAL".
  3. Se for informado um identificador de adolescente que ainda não existe na base da PSE, o serviço de cadastrar adolescente também será acionado, criando-se o respectivo "Identificador"
  4. O serviço não deve ser executado se o "Nº do processo" informado estiver com a situação inativa na base da PSE.
  5. O serviço não deve ser executado se o adolescente que já possuía vínculo ativo com o respectivo processo e se tiver vínculo com processo "ativo" do tipo: EXECUÇÃO DE MEDIDA SOCIOEDUCATIVA.

DELETE//api/v1/processos/{numeroProcesso}/apuracao/adolescentes/{identificadorAdolescente}​

Essa API permite a exclusão do adolescente no processo de Processo de Apuração de Ato Infracional.

Nesse serviço é obrigatório passar os parâmetros abaixo:

  • Identificador do Adolescente.
  • Número do Processo

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

  1. O serviço será executado somente se o "Nº do processo" informado existir na base do Socioeducativo.
  2. O serviço será executado somente se o "Nº do processo" informado for do tipo "APURAÇÃO DE ATO INFRACIONAL".
  3. Se for informado um identificador de adolescente que ainda não existe na base da PSE, o serviço de cadastrar adolescente também será acionado, criando-se o respectivo "Identificador"
  4. O serviço não deve ser executado se o "Nº do processo" informado estiver com a situação inativa na base da PSE.
  5. O serviço não deve ser executado se o adolescente que já possuía vínculo ativo com o respectivo processo e se tiver vínculo com processo "ativo" do tipo: EXECUÇÃO DE MEDIDA SOCIOEDUCATIVA.

GET/api/v1/processos/apuracao/numero-processo/{numeroProcesso}​

Essa API permite realizar a consulta de processo de apuração de ato infracional, se no parâmetro for informado o processo de execução, o response vai retornar o processo de apuração vinculaddo a ele.

Nesse serviço é obrigatório passar o parâmetro numeroProcesso.

GET/api/v1/processos/numero-processo/{numeroProcesso}​

Essa API permite realizar a consulta de processos passando o parâmetro numeroProcesso como obrigatório.

PUT/api/v1/processos/numero-processo/{numeroProcesso}/situacao/{situacao}​

Essa API permite atualização da situação dos processos, seja de apuração de ato infracional ou execução de medidas.

Nesse serviço é obrigatório passar os parâmetros abaixo:

  • Número do Processo
  • Situação
    • Arquivado
    • Ativo

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

  1. O serviço será executado somente se o nº do processo informado existir na base do Socioeducativo.
  2. O serviço será executado somente se o nº do processo informado estiver no padrão de identificação única do CNJ.
  3. O serviço não deverá considerar como alteração a situação informada que possuir o mesmo valor da situação atual.