[API] Consultar amparo legal
Origem
A origem dessa demanda provém de uma necessidade encontrada para utilizar a API Minuta de Empenho.
Descrição
Criar API responsável por consultar os dados de amparos legais cadastrados no Contratos.
Critérios de Aceitação
1. Criar API
1.1. Nome: Consultar Amparo Legal
1.2. Método: POST
1.3. URI do recurso: /api/v1/amparo/consultar
1.4. Dados de Entrada
Id | Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|---|
1 | modalidade | String | Não | Tipo de modalidade do amparo (Tabela de Domínio "modalidade") (exemplo: "Pregão") |
2 | ato_normativo | String | Não | Referência ao ato normativo do amparo (exemplos: "LEI 14.628/2023", "DECRETO 10.024/2019") |
3 | artigo | String | Não | Número do artigo do amparo (exemplos: "184", "11C") |
4 | paragrafo | String | Não | Número do parágrafo do amparo (exemplos: "1","2") |
5 | inciso | String | Não | Número do inciso do amparo (exemplo: "III", "CAPUT") |
6 | alinea | String | Não | Letra da alínea do amparo (exemplo: "A", "B") |
1.5. Dados de Retorno
Id | Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|---|
1 | status | String | Sim | Status devolvido pela API |
2 | message | String | Sim | Mensagem retornada pelo serviço |
3 | amparo_legal | array | Sim | Bloco de informações que representam os amparos legais |
3.1 | id_amparo | Integer | Sim | Id do amparo legal |
3.1 | descricao_amparo | String | Sim | Descrição do amparo legal |
1.6. Mensagem de Retorno
Mensagem | Tipo | Descrição |
---|---|---|
Lista de amparos retornada com sucesso. | Sucesso | Consulta realizada com sucesso |
Token expirado. | Erro | Falha de autorização devido à expiração do token |
Usuário sem permissão no sistema. | Erro | Falta de permissão do usuário para utilizar a API |
Amparo não encontrado. | Erro | Amparo informado não foi encontrado |
Erro interno do servidor | Erro | Erro interno no servidor, a aplicação está inacessível |
2. Atualizar documentação da API no Swagger do sistema
Observações para o desenvolvedor
- Consultar as tabelas "amparo_legal" e "codigoitens".
- Campo "descricao" deve concatenar as informações, conforme exemplo abaixo: {Ato Normativo} - Artigo: {artigo} - Parágrafo: {paragrafo} - Inciso: {inciso} - Alínea: {alinea}
Tabela de Domínio
Código | Modalidade (Identificador da modalidade) |
---|---|
Convite | Modalidade compra do tipo "Convite" |
Tomada de Preços | Modalidade compra do tipo "Tomada de Preços" |
Concorrência | Modalidade compra do tipo "Concorrência" |
Concorrência Internacional | Modalidade compra do tipo "Concorrência Internacional" |
Pregão | Modalidade compra do tipo "Pregão" |
Dispensa | Modalidade compra do tipo "Dispensa" |
Inexigibilidade | Modalidade compra do tipo "Inexigibilidade" |
Suprimento de Fundos | Modalidade compra do tipo "Suprimento de Fundos" |
Concurso | Modalidade compra do tipo "Concurso" |
Tomada de Preços por Técnica e Preço | Modalidade compra do tipo "Tomada de Preços por Técnica e Preço" |
Concorrência por Técnica e Preço | Modalidade compra do tipo "Concorrência por Técnica e Preço" |
Concorrência Internacional por Técnica e Preço | Modalidade compra do tipo "Concorrência Internacional por Técnica e Preço" |
Regime Diferenciado de Contratações | Modalidade compra do tipo "Regime Diferenciado de Contratações" |
Roteiro de Testes
Edited by Renato Vieira