Código fonte Wiki de Documento - Documentação da API BNMP2

Última modificação por Max Antônio Rodrigues de Assis em 13/03/2020, 17:00
  1: Documentação completa de programação da API do  BNMP 2.0, com a definição de todos os métodos e objetos trocados.
  2: 
  3: Versões disponíveis nos anexos
  4: 
  5: =   =
  6: 
  7: = Versão 0.10.0 / 0.10.1 / 0.10.2 / 0.10.3 / 0.10.4 =
  8: 
  9: = Versão 0.11.0 / 0.11.1 / 0.11.2 / 0.11.3 =
 10: 
 11: = Versão 0.12.x / 0.12.31 - Renumeração Versão 2.0.0 =
 12: 
 13: 0.12.6 - [HOT FIX] Versão 0.12.4 BNMP 2.0 - DASHBOARD - Geração dos Logs para entender o problema
 14: 
 15: 0.12.7 - [HOTFIX] ERRO PRODUÇÃO - BONFIM/TJRR - RJI: 17000246867 (Kennedy Vital Nascimento)
 16: 
 17: 0.12.8 - [HOT FIX] TJGO - 23/01 - RJI 180550621-21 - Status: Procurado
 18: 
 19: 0.12.9 - [HOT FIX] Pesquisa de Pessoas -> Inconsistência na pesquisa por nomes
 20: 
 21: 0.12.16 - Não houveram alterações na API, entretanto foi adicionada a validação no backend para a obrigatoriedade de regime prisional no cadastro de mandado de prisão.
 22: 
 23: 0.12.18 - Foi adicionado um método para indexar pessoas baseados em uma lista de ids.
 24: 
 25: 0.12.23 - Foi adicionado obrigatoriedade no atributo regimePrisional de Guia de Recolhimento e foi adicionado o tratamento para o endpoint GET /api/pessoas/rji/{rji} para quando a pessoa não existir.
 26: 
 27: 0.12.24 - A consulta de peças foi reescrita para usar um novo endpoint com query nativa, o endpoint anterior foi mantido por causa dos problemas que já tivemos em alterá-lo.
 28: 
 29: = Versão 0.13.0 / 0.13.1 / 0.13.2 / 0.13.6 / 0.13.7 =
 30: 
 31: 0.13.0:
 32: 
 33: -Os endpoints de Naturalidade, Nacionalidade, Pais, Estado (UnidadeFederativa) e Municipio foram movidos para o SCA:
 34: 
 35: GET BNMP /estados -> GET SCA /unidades-federativas
 36: 
 37: GET BNMP /estados/pais/{idPais} -> GET SCA /unidades-federativas/pais/{idPais}
 38: 
 39: GET BNMP /municipios/estado/{idEstado} -> GET SCA /municipios/por-uf/{idEstado}
 40: 
 41: GET BNMP /pais -> GET SCA /pais
 42: 
 43: GET BNMP /nacionalidades -> GET SCA /nacionalidades
 44: 
 45: GET BNMP /naturalidades -> GET SCA /naturalidades
 46: 
 47: GET BNMP /naturalidades/estado/{idEstado} -> GET SCA /naturalidades/estado/{idEstado}
 48: 
 49: -EstadoDTO se chama agora UnidadeFederativaDTO, possuem os mesmos atributos.
 50: 
 51: -Alteração funcional em GET /api/pecas/check-novo-cadastro/{numeroIndividuo}:
 52: Agora retorna um Map onde na chave "numeroProcessos" existe um Set contendo os números de processos com Certidão de Extinção de Punibilidade ativa.
 53: 
 54: -Adição do POST /api/certidao-extincao-punibilidades/mandados-por-numero-processo.
 55: -Remoção GET /api/certidao-extincao-punibilidades/concluidos-punibilidade/{numeroIndividuo}
 56: 
 57: -Alteração da propriedade municipios para municipio no CertidaoExtincaoPunibilidadeDTO.
 58: 
 59: 0.13.6 - Foram removidos todos os endpoints de assinatura EXCETO os que usam o método GET.
 60: 
 61: = Versão 0.14.0 / 0.14.4 / 0.14.8 / 0.14.9 / 0.14.10 / 0.14.11 - Renumeração Versão 2.0.0 =
 62: 
 63: 
 64: 0.14.0 - Foram removidos os endoins de assinar certidao de extinção de punibilidade e de certidão de arquivamento de guia, exceto os de método GET, que não foram removidos na versão anterior.
 65: 
 66: 0.14.4 - Em todos os endpoints de assinatura a partir desta versão é obrigatório apresentar a data e hora local.
 67: 
 68: 0.14.8 - Não houveram alterações na API, entretanto foi adicionada a validação no backend para a obrigatoriedade de regime prisional no cadastro de mandado de prisão.
 69: 
 70: 0.14.10 - As obrigatoriedades dos campos totalDiaPrazoMinimoInternacao, totalMesPrazoMinimoInternacao e totalAnoPrazoMinimoInternacao em Guia de Internação (Medida Segurança Aplicada) e totalPenaAnos, totalPenaMeses e totalPenaDias de Guia de Internação (Acervo da Execução) (Historico Medida de Segurança) foram removidos.
 71: 
 72: 
 73: = Versão 2.0.20 / 2.0.21 / 2.0.22 / 2.0.23 / 2.0.24 / 2.0.25 / 2.0.26 / 2.0.27 / 2.0.28 / 2.0.29 / 2.0.30 / 2.0.31 / 2.0.32 / 2.0.33 / 2.0.36 / 2.0.37 / 2.0.38 / 2.0.39 =
 74: 
 75: (% style="background:white; color:#333333; font-family:~"Arial~",sans-serif; font-size:10.5pt" %)2.0.20 - Todos os endpoints de relatórios (13) foram refeitos para retornar o VO (em detrimento dos ListDTOs). Uma entidade mais enxuta e com menos atributos com intuito de otimização de performance.
 76: 
 77: (% style="background:white; color:#333333; font-family:~"Arial~",sans-serif; font-size:10.5pt" %)2.0.20 - Adicionado à todos os endpoints de assinatura, confirmação de assinatura e conclusão de peça validação de status.
 78: 
 79: (% style="background:white; color:#333333; font-family:~"Arial~",sans-serif; font-size:10.5pt" %)2.0.26 - A(%%)dição dos endpoints para os novos relatórios.
 80: 
 81: = Versão 0.15.0 / 0.15.1 / 0.15.2 / 0.15.3 / 0.15.4 / 0.15.5 / 0.15.6 /0.15.7 / 0.15.8 / 0.15.9 - Renumeração versão 2.1.0 =
 82: 
 83: 0.15.1 - Foi adicionado um método para indexar pessoas baseados em uma lista de ids.
 84: 0.15.6 - (% style="color:#222222; font-family:~"Arial~",sans-serif; font-size:9.5pt" %)As obrigatoriedades dos campos totalDiaPrazoMinimoInternacao, totalMesPrazoMinimoInternacao e totalAnoPrazoMinimoInternacao em Guia de Internação (Medida Segurança Aplicada) e totalPenaAnos, totalPenaMeses e totalPenaDias de Guia de Internação (Acervo da Execução) (Historico Medida de Segurança) foram removidos.
 85: 
 86: 0.15.8 - Foi adicionado obrigatoriedade no atributo regimePrisional de Guia de Recolhimento e foi adicionado o tratamento para o endpoint GET /api/pessoas/rji/{rji} para quando a pessoa não existir.
 87: 
 88: 0.15.9 - A consulta de peças foi reescrita para usar usar um novo endpoint com query nativa, o endpoint anterior foi mantido por causa dos problemas que já tivemos em alterá-lo.
 89: 
 90: = Versão 0.16.0 / 0.16.1 / 0.16.2 / 0.16.3 / 0.16.4 - Renumeração da versão 2.2.0 =
 91: 
 92: 0.16.0 - Foram adicionados 3 endpoints para a nova funcionalidade de relatório de status por pessoa.
 93: 
 94: 
 95: = Versão 2.2.1 / 2.2.2 / 2.2.3 / 2.2.4 / 2.2.5 / 2.2.6 / 2.2.7 / 2.2.8 / 2.2.10 ... 2.2.16 =
 96: 
 97: (% style="background:white; color:#333333; font-family:~"Arial~",sans-serif; font-size:10.5pt" %)1- Todos os endpoints de relatórios (13) foram refeitos para retornar o VO (em detrimento dos ListDTOs). Uma entidade mais enxuta e com menos atributos com intuito de otimização de performance.
 98: 
 99: (% style="background:white; color:#333333; font-family:~"Arial~",sans-serif; font-size:10.5pt" %)2- Adicionado à todos os endpoints de assinatura, confirmação de assinatura e conclusão de peça validação de status.
100: 
101: = Versão 2.3.x =
102: 
103: 
104: = Versão 2.4.x =
105: 
106: 
107: = Versão 2.5.x =
108: 
109: 
110: = Versão 2.6.x =
111: 
112: 
113: = Versão 2.7.x =
114: 
115: 
116: = Versão 2.8.x =
117: 
118: = Versão 2.9.x =
119: 
120: = Versão 2.10.x =
121: 
122: = Versão 2.11.x =
123: 
124: = Versão 2.12.x =
125: 
126: = Versão 2.13.x =
127: 
128: = Versão 2.14.x =
129: 
130: = Versão 2.15.x =
131: 
132: = Versão 2.16.x =