Documentação da API de Proposições

URLs dos Endpoints

https://dadosabertos.alepe.pe.gov.br/api/v1/proposicoes/projetos/

https://dadosabertos.alepe.pe.gov.br/api/v1/proposicoes/indicacoes/

https://dadosabertos.alepe.pe.gov.br/api/v1/proposicoes/requerimentos/

Descrição

Esta API permite consultar dados de proposições legislativas (projetos de lei, indicações e requerimentos) da Assembleia Legislativa de Pernambuco. Cada tipo de proposição possui seu próprio endpoint específico, garantindo que os dados sejam sempre retornados separadamente por tipo.

Funcionalidades

1. Consulta de Proposição Específica

Retorna os dados completos de uma proposição específica através do número e ano.

2. Consulta de Múltiplas Proposições

Retorna dados resumidos de múltiplas proposições filtradas por ano e/ou legislatura.

1. Proposição Específica

Método

GET

URL

https://dadosabertos.alepe.pe.gov.br/api/v1/proposicoes/{tipo}/?numero={numero}&ano={ano}

Tipos Disponíveis

projetos - Para projetos de lei
indicacoes - Para indicações
requerimentos - Para requerimentos

Parâmetros de Consulta - Proposição Específica

Parâmetro	Descrição	Tipo	Opcional
`numero`	Número da proposição que se deseja consultar.	Integer	Não
`ano`	Ano da proposição que se deseja consultar.	Integer	Não
`formato`	Especifica o formato da resposta. Os formatos suportados são `xml` (padrão) e `csv`.	String	Sim

2. Múltiplas Proposições

Método

GET

URL

https://dadosabertos.alepe.pe.gov.br/api/v1/proposicoes/{tipo}/

Importante: Quando nenhum filtro for fornecido, a API automaticamente utilizará o ano corrente como filtro padrão.

Parâmetros de Consulta - Múltiplas Proposições

Parâmetro	Descrição	Tipo	Opcional
`ano`	Filtra as proposições pelo ano. Se não informado e nem legislatura, usa o ano corrente automaticamente.	Integer	Sim
`legislatura`	Filtra as proposições pela legislatura.	Integer	Sim
`formato`	Especifica o formato da resposta. Os formatos suportados são `xml` (padrão) e `csv`.	String	Sim

Resposta

Formato

A resposta pode estar em formato XML ou CSV, dependendo do parâmetro de consulta formato.

XML - Proposição Específica

Retorna o XML completo da proposição (coluna dados da tabela):

<?xml version="1.0" encoding="utf-8"?>
<proposicao>
    <numero>123</numero>
    <ano>2024</ano>
    <tipo>projeto</tipo>
    <!-- dados completos da proposição -->
</proposicao>

XML - Múltiplas Proposições

Retorna um XML estruturado com dados resumidos:

<?xml version="1.0" encoding="utf-8"?>
<projetos>
    <!-- dados resumidos dos projetos -->
</projetos>

CSV

Para proposição específica: coluna única com o XML completo.

Para múltiplas proposições: coluna única com dados resumidos de cada proposição.

Esquemas XML (XSD)

Disponível apenas para consultas específicas: Os esquemas XSD descrevem a estrutura dos dados XML retornados quando você consulta uma proposição específica informando número e ano.

Arquivos de Esquema por Tipo de Proposição

Tipo de Proposição	Esquema XSD	Descrição
Projetos de Lei	ProjetoXML.xsd	Define a estrutura XML para dados detalhados de projetos de lei
Indicações	IndicacaoXML.xsd	Define a estrutura XML para dados detalhados de indicações
Requerimentos	RequerimentoLegislativoXML.xsd	Define a estrutura XML para dados detalhados de requerimentos legislativos

Como Usar os Esquemas

Validação: Use os esquemas XSD para validar a estrutura dos dados XML retornados pela API
Desenvolvimento: Utilize os esquemas para gerar classes ou estruturas de dados em seu código
Documentação: Os esquemas servem como documentação técnica da estrutura dos dados

Nota: Os esquemas XSD se aplicam apenas aos dados retornados nas consultas específicas (quando informado número e ano). Para consultas de múltiplas proposições, os dados retornados são resumidos e seguem uma estrutura simplificada.

Exemplos de Uso

Proposição Específica

/api/v1/proposicoes/projetos/?numero=123&ano=2024
/api/v1/proposicoes/indicacoes/?numero=456&ano=2023&formato=csv
/api/v1/proposicoes/requerimentos/?numero=789&ano=2024

Múltiplas Proposições

/api/v1/proposicoes/projetos/ (usa ano corrente automaticamente)
/api/v1/proposicoes/projetos/?ano=2024
/api/v1/proposicoes/indicacoes/?legislatura=19
/api/v1/proposicoes/requerimentos/?ano=2023&formato=csv
/api/v1/proposicoes/projetos/?ano=2024&legislatura=19

Teste a API - Proposição Específica

Teste a API - Múltiplas Proposições

Códigos de Erro

Erro	Descrição
Tipo não especificado	URL não contém um tipo válido de proposição (projetos, indicacoes, requerimentos)
Erro na conexão	Problema na conexão com o banco de dados
Erro na consulta SQL	Problema na execução da consulta no banco de dados
Proposição não encontrada	Nenhuma proposição foi encontrada com os critérios especificados