1. Consulta:

POST

{base_url}/api/servicos/consulta/

Realiza consultas na base civil ou criminal com os parâmetros de pesquisa enviados no corpo da requisição. Estes parâmetros são:

• nome: String, contendo o nome do indivíduo no qual se deseja realizar a consulta.
• rg: String, contendo o número do RG do indivíduo no qual se deseja realizar a consulta.
• cpf: String, cuja formatação é 99999999999. Número do CPF do indivíduo no qual se deseja realizar a consulta.
• nomePai: String, contendo o nome do pai do indivíduo no qual se deseja realizar a consulta.
• nomeMae: String, contendo o nome da mãe do indivíduo no qual se deseja realizar a consulta.
• tipoConsulta: Número, sendo o valor 0 indicando uma consulta civil, e 1 indicando uma consulta criminal.

A mensagem JSON contendo o corpo da requisição deve seguir o padrão indicado pelos exemplos abaixos:

{
  "nome":"OSCAR",  
  "rg":"000.501-A",
  "cpf":"",
  "nomePai":"",
  "nomeMae":"",
  "tipoConsulta":0
}

{ 
    "nome":"",
    "rg":"",
    "cpf":"12345678900",
    "nomePai":"",
    "nomeMae":"",
    "tipoConsulta":1 
}

A requisição não possui nenhum campo obrigatório, desde que ao menos um campo esteja preenchido. Isso significa que uma requisição pode ser realizada contendo apenas uma única informação, ou contendo uma combinação destas informações.

No caso de sucesso, a operação retorna uma mensagem JSON contendo os seguintes campos:

• sucesso: Boolean. Indica se há algum erro na requisição ou se ocorreu erro na consulta (recebendo o valor false) ou se a consulta foi bem sucedida (recebendo o valor true)
• erros: Array. No caso de uma requisição com o campo sucesso preenchido como false, Conterá aqui a descrição dos erros ocorridos.
• dados: Array. Resultado das consultas contendo as informações referente aos documentos encontrados. Caso este campo esteja vazio enquanto o campo sucesso estiver preenchido como true, isso significa que não houve nenhum resultado encontrado para as informações dadas. Os campos contidos neste array são:
  • nome: String. Nome do indivíduo
  • nomePai: String. Nome do pai do indivíduo
  • nomeMae: String. Nome da mãe do indivíduo
  • rg: String. RG do indivíduo
  • cpf: String. CPF do indivíduo
  • dataNascimento: String. Data de nascimento do indivíduo no formato dd/mm/yyyy
  • endereço: String. Endereço do indivíduo no formato RUA - NÚMERO - BAIRRO - CIDADE
  • telefone: String. Telefone cadastrado na base civil/criminal
  • dataAtendimento: Data do atendimento realizado no sistema, no formato dd/mm/yyyy
  • alcunha: String. Alcunha do indivíduo (para consultas do tipoConsulta = 1)
  • fotoUrl: String. URL para download da foto do resultado encontrado. Deverá ser feita uma requisição GET para o link indicado, utilizando a mesma autenticação Basic da consulta.

Um exemplo de resposta bem sucedida pode ser visto abaixo:

{
    "sucesso": true,
    "erros": [],
    "dados": [
        {
        "nome": "OSCAR",
        "nomePai": "NOME1",
        "nomeMae": "NOME2",
        "rg": "000.501-A",
        "cpf": "999.999.999-99",
        "dataNascimento": "12/12/1990",
        "endereco": "RUA ALGUM LUGAR- 333 - BAIRRO TESTE - CIDADE TESTE",
        "telefone": "(99) 99999-9999",
        "dataAtendimento": "19/11/2018 16:18:54",
        "alcunha": null,
        "fotoUrl":"{base_url}/api/servicos/c/imagem/26cde9cda1bc4530a635b319ee6cf06e"
        }
    ]
}

{
    "sucesso": true,
    "erros": [],
    "dados": []
}

{
    "sucesso": false,
    "erros": [
    "'Cpf' não está no formato 00000000000",
    "'TipoConsulta' inválido"
    ],
    "dados": []
}

• Status da requisição 404: "Usuário e/ou senha incorretos.". Indica que o nome de usuário (Basic - username) não foi encontrado no banco de dados da API e/ou a senha (Basic - password) está incorreta.
• Status da requisição 403: "Esse usuário não tem acesso a esse recurso da API."
• Status da requisição 401: "Usuário inativo." Nome de usuário encontrado na API porém, o usuário não está ativo no sistema.

2. Glossário:

Convenções:

• Caller - Aplicação cliente.
• Request - Requisição do cliente.
• Response - Resposta da API.
• Status - Código status HTTP de response.
• Todos os requests/responses devem estar no formato JSON.

Todos os códigos status de response utilizados seguem os códigos padrões HTTP. Abaixo estão as descrições de alguns deles.

• 2XX - Sucesso
• 4XX - Erro do lado cliente
• 5XX - Erro do lado servidor