Adolescentes

Integração dos adolescentes

Este documento tem como objetivo, apresentar informações técnicas para auxiliar os tribunais na utilização dos serviços de integração dos adolescentes.

A integração dos adolescentes é composta por sete serviços, como o destaque na iamgem abaixo abaixo.

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

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

Como na imagem das APIs de integração dos adolescentes já tem uma breve descrição do que cada serviço executa, abaixo segue o link de cada uma com uma explicação mais definida das execuções.

• GET/api/v1/adolescentes;
• POST/api/v1/adolescentes;
• PUT/api/v1/adolescentes;
• GET/api/v1/adolescentes/cpf/{cpf};
• GET/api/v1/adolescentes/identificador/{identificador};
• GET/api/v1/adolescentes/verificar-similaridade;
• POST/api/v1/adolescentes/verificar-similaridade;

GET/api/v1/adolescentes

Esse serviço permite realizar a consulta de adolescentes na base socioeducativa sem informar parâmetros, e quando executado o serviço retorna todos os adolescentes pertencentes ao tribunal em que está vinculado o usuário que executou o serviço.

POST/api/v1/adolescentes

O serviço de POST/api/v1/adolescentes é o serviço que integrada o adolescente a plataforma socioeducativa com a execução do Json abaixo:

{
  "certidaoNascimento": {
    "cartorio": "string",
    "folha": "string",
    "livro": "string",
    "numero": "string"
  },
  "cpf": {
    "numero": "string"
  },
  "dataNascimento": "string",
  "dataNascimentoPresumida": "S",
  "identidadeGenero": "NAO_INFORMADO",
  "naturalidade": "string",
  "nome": "string",
  "nomeMae": "string",
  "nomePai": "string",
  "nomeSocial": "string",
  "orientacaoSexual": "NAO_INFORMADO",
  "possuiNomeSocial": "S",
  "racaCor": "NAO_INFORMADO",
  "rg": {
    "dataExpedicao": "string",
    "estadoRg": "AC",
    "numero": "string",
    "orgaoExpedidor": "string"
  },
  "sexoBiologico": "MASCULINO",
  "sobrenome": "string"
}

Na imagem abaixo da API POST contém a aba Model que é composta pelo DTO com todos os atributos que irão compor o preenchimento do Json para execução do serviço de integração do adolescente.

PUT/api/v1/adolescentes

Esse serviço permite realizar alteração nos dados do adolescente, o JSON passado é o mesmo do serviço de "POST/api/v1/adolescentes", com dois parâmetros a mais que é o Identificador e dataObito.

GET/api/v1/adolescentes/cpf/{cpf}

Esse serviço permite consultar o adolescente passando como obrigatório o parâmetro número do CPF. Se a consultar for realizada com sucesso, o response retorna o status code 200 e apresenta o Json contendo os dados do adolescente.

GET/api/v1/adolescentes/identificador/{identificador}

Esse serviço permite consultar o adolescente passando como obrigatório o parâmetro Identificador. Se a consultar for realizada com sucesso, o response retorna o status code 200 e apresenta o Json contendo os dados do adolescente.

GET/api/v1/adolescentes/verificar-similaridade

Esse serviço permite retornar dados do adolescente por campos de similaridades, passando os parâmetros abaixo como obrigatório no serviço:

• Data de Nascimento
• Primeiro Nome
• Sexo Biológico
• Sobrenome

POST/api/v1/adolescentes/verificar-similaridade

Esse serviço recebe os mesmo parâmetros passados no JSON do "POST/api/v1/adolescentes", porém existe algumas regras de validações na execução do serviço.

1. O serviço realiza um cálculo de similaridade com base nos seguintes dados:
• Primeiro nome
• Sobrenome
• Sexo biológico
• Data de nascimento
2. O serviço deve considerar que é o mesmo adolescente quando o percentual de similaridade seja superior a 90% (considerado a biblioteca Jaro Winkler Distance da apache)
3. O serviço deve identificar o adolescente como único quando identificar o mesmo CPF já registrado na base de dados
4. O serviço deve identificar o adolescente como único quando identificar o mesmo RG (número e estado) já registrado

Então, quando executado o serviço e o retorno contenha similaridades conforme as regras acima, o serviço retorna o status code 200 com a mensagem "Existe(m) adolescente(s) que possui(em) similaridade com os dados enviados."