Introdução Guias

Explicação técnica da integração das Guias

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 das Guias que atualmente são compostas pelas guias abaixo:

• Definitiva
• Provisória
• Unificadora
• Internação Provisória
• Internação Sanção

Para compor a integração de cada uma das guias, é necessário que primeiro realizar a integração dos serviços abaixo que terão como retorno o identificador do adolescente e o número do processo seja o "Processo de Ato Infracional" e/ou "Processo de execução de medidas".

• POST/api/v1/processo-rascunho,
• POST/api/v1/adolescentes,
• POST/api/v1/processos .

A imagem abaixo é um demonstrativo dos serviços de integração de todas as guias.

As guias são separadas por tribunais em acordo com o tribunal vinculado ao usuário que executar os serviços.

NOTA: Ao expandir qualquer API POST será apresentado a coluna Modelonde se explica os tipos de parâmetros que o JSON espera receber, como por exemplo documentosInstruirGuiaque é apresentado uma lista de tipos de documentos do adolescente e alguns documentos específicos que contempla cada guia, também é apresentado os tipos de origemGuia que a guia especifíca aceita.

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

O serviços abaixo são de consultas gerais de todas as guias.

• GET/api/v1/guias;
• POST/ api/v1/guias/amqp/enviar/pdf/base64;
• GET/ api/v1/guias/ativas;

GET/api/v1/guias

Essa API permite que seja executado a consulta de guias 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 todas as guias.

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

1. Identificador Adolescente
2. Número do processo de Apuração de Ato Infracional
3. Número do processo de Execução de Medidas
4. Número do processo de Referência
5. Situação das Guias
• Ativo
• Inativo
6. Tipos de guias abaixo
• Definitiva
• Provisória
• Unificadora
• Internação Provisória
• Internação Sanção

GET/ api/v1/guias/amqp/enviar/pdf/base64

Essa API permite anexar o PDF base64 da guia na fila do RabbitMQ para consumo das aplicações, como parâmetro de entrada o JSON recebe o número da guia do tipo string.

GET/ api/v1/guias/ativas

Essa API permite que seja executado a consulta de guias ativas 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." apresentando a lista de todas as guias ativas.

Abaixo são os parâmetros obrigatórios da pesquisa:

• Identificador Adolescente
• Numero do processo
• Tipo de Guia
• Definitiva
• Provisória
• Unificadora
• Internação Provisória
• Internação Sanção

Todas as regras de execução dos serviços das guias serão explicados nos demais menus indicados de cada guia.