legislei.SDKs.CamaraDeputados.entidades module

class legislei.SDKs.CamaraDeputados.entidades.Deputados

Bases: legislei.SDKs.CamaraDeputados.restful.RESTful

Cliente para obtenção de dados de deputados

Essa classe deve ser instanciada para obtenção de dados referentes aos deputados da atual legisltatura da Câmara dos Deputados.

Exemplo:

dep = Deputados()

obterDeputado(dep_id)

Obtém detalhes sobre um deputado

Obtém informações sobre o deputado identificado pelo id fornecido por dep_id.

Exemplo:

deputado = dep.obterDeputado(dep_id)

Parâmetros:dep_id (String) – Id de deputado Retorno:Dicionário de informações de deputado Tipo de retorno:  Dictionary

obterEventosDeputado(dep_id, **kwargs)

Obtém todos os eventos que um deputado participou

Obtém todas os eventos nos quais a participação do deputado identificado por dep_id era ou é prevista.

Exemplo:

for pagina in dep.obterEventosDeputado(dep_id, ordem='asc):
    for evento in pagina:
        print(evento)

Parâmetros:

• dep_id (String) – Id do deputado
• dataInicio (String) – Data de início de intervalo de tempo no formato AAAA-MM-DD
• dataFim (String) – Data de término de intervalo de tempo no formato AAAA-MM-DD
• ordem (String) – Sentido de ordenação—asc para ordem ascendente e desc para descendente
• ordenarPor (String) – Nome de campo pelo qual a lista deve ser ordenada: dataHoraInicio

Retorno:

Generator de páginas de lista de eventos

Tipo de retorno:  

Generator

obterOrgaosDeputado(dep_id, **kwargs)

Obtém todos os órgãos de um deputado

Obtém a lista dos órgãos dos quais o deputado identificado por dep_id faz parte durante o período fornecido pelos parâmetros de filtro. Se não for especificado nenhum parâmetro de tempo, serão retornados os órgãos aos quais o parlamentar faz parte no momento da requisição.

Exemplo:

for pagina in dep.obterOrgaosDeputado(dep_id, ordem='asc'):
    for orgaos in pagina:
        print(orgaos)

Parâmetros:

• dep_id (String) – Id de deputado
• dataInicio (String) – Data de início de intervalo de tempo no formato AAAA-MM-DD
• dataFim (String) – Data de término de intervalo de tempo no formato AAAA-MM-DD
• ordem (String) – Sentido de ordenação—asc para ordem ascendente e desc para descendente
• ordenarPor (String) – Nome de campo pelo qual a lista deve ser ordenada: idOrgao, siglaOrgao, nomeOrgao, nomePapel, dataInicio e dataFim

Retorno:

Generator de páginas de lista de órgãos

Tipo de retorno:  

Generator

obterTodosDeputados(**kwargs)

Obtém todos os deputados da atual legislatura

Se não forem fornecidos parâmetros de filtro, somente serão retornados os deputados em exercício no momento da requisição.

Exemplo:

for pagina in dep.obterTodosDeputados(ordenarPor='nome'):
    for deputado in pagina:
        print(deputado)

Parâmetros:

• id (List) – Lista de ids de deputados
• nome (String) – Nome de deputado
• idLegislatura (List) – Ids de legislaturas
• siglaUf (List) – Siglas de Unidades Federativas
• siglaPartido (List) – Siglas de partidos políticos
• siglaSexo (String) – «M» para masculino e «F» para feminino
• dataInicio (String) – Data de início de um intervalo de tempo, no formato AAAA-MM-DD
• dataFim (String) – Data de fim de um intervalo de tempo, no formato AAAA-MM-DD
• ordem (String) – Sentido de ordenação—asc para ordem ascendente e desc para descendente
• ordenarPor (String) – Nome do campo pelo qual a lista de deputados deve ser ordenada: id, idLegislatura, nome, siglaUF ou siglaPartido

Retorno:

Generator de páginas de lista de dicionário de informações sobre os deputados

Tipo de retorno:  

Generator

class legislei.SDKs.CamaraDeputados.entidades.Eventos

Bases: legislei.SDKs.CamaraDeputados.restful.RESTful

Cliente para obtenção de dados de eventos da Câmara dos Deputados

Essa classe deve ser instanciada para a obtenção de dados dos eventos da Câmara dos Deputados.

Exemplo:

ev = Eventos()

obterDeputadosEvento(ev_id)

Obtém deputados participantes do evento identificado por ev_id

Se o evento já ocorreu, são retornados os parlamentares que registraram presença no evento. Se o evento ainda está para acontecer, então são retornados deputados cuja presença é prevista.

Exemplo:

deputados_presentes = ev.obterDeputadosEvento(ev_id)

Parâmetros:ev_id (String) – Identificador de um evento Retorno:Lista deputados presentes/previstos Tipo de retorno:  List

obterEvento(ev_id)

Obtém informações sobre o evento identificado por ev_id

Exemplo:

evento = ev.obterEvento(ev_id)

Parâmetros:ev_id (String) – Identificador de um evento Retorno:Dicionário de informações do evento Tipo de retorno:  Dictionary

obterPautaEvento(ev_id)

Obtém as proposições de um evento de caráter deliberativo

Se o evento identificado por ev_id for de caráter deliberativo, é retornada a lista de proposições escolhidos para avaliação parlamentar no evento em questão.

Exemplo:

evento_pauta = ev.obterPautaEvento(ev_id)

Parâmetros:ev_id (String) – Identificador de um evento Retorno:Lista de proposições de um evento Tipo de retorno:  List

obterTodosEventos(**kwargs)

Obtém todos os eventos da Câmara dos Deputados

Se nenhum parâmetro de filtro for passado, serão retornados os eventos ocorridos nos dois dias anteriores à data atual, eventos previstos para os próximos dois dias e eventos do próprio dia atual.

Exemplo:

for pagina in ev.obterTodosEventos():
    for evento in pagina:
        print(evento)

Parâmetros:

• id (List) – Identificador numérico de eventos
• codTipoEvento (List) – Identificador numérico do tipo de evento; valores válidos podem ser obtidos através de /referencias/tiposEvento
• codSituacao (List) – Identificador numérico do tipo de situação de evento; valores válidos podem ser obtidos através de /referencias/situacoesEvento
• codTipoOrgao (List) – Identificador numérico de tipos de órgãos realizadores do evento; valores válidos podem ser obtidos através de /referencias/tiposOrgao
• dataInicio (String) – Data de início de intervalo de tempo no formato AAAA-MM-DD
• dataFim (String) – Data de término de intervalo de tempo no formato AAAA-MM-DD
• horaInicio (String) – Hora de início de intervalo de tempo no formato hh:mm
• horaFim (String) – Hora de término de intervalo de tempo no formato hh:mm
• ordem (String) – Sentido de ordenação—asc para ordem ascendente e desc para descendente
• ordenarPor (String) – Nome de campo pelo qual a lista deve ser ordenada: id, dataHoraInicio, dataHoraFim, descricaoSituacao, descricaoTipo ou titulo

Retorno:

Generator de páginas de lista de eventos

Tipo de retorno:  

Generator

class legislei.SDKs.CamaraDeputados.entidades.Proposicoes

Bases: legislei.SDKs.CamaraDeputados.restful.RESTful

Cliente para obtenção de dados de proposições

Essa classe deve ser instanciada para a obtenção de dados referentes a proposições da Câmara dos Deputados.

Exemplo:

prop = Proposicoes()

obterAutoresProposicao(prop_id)

Obtém autores de proposição identificada por prop_id

Entre possíveis autores, além de parlamentares, estão instituições dos três poderes e da sociedade civil.

Exemplo:

proposicao_autores = prop.obterAutoresProposicao(prop_id)

Parâmetros:prop_id (String) – Identificador de proposição Retorno:Lista de autores de proposição Tipo de retorno:  List

obterProposicao(prop_id)

Obtém informações sobre a proposição identificada por prop_id

Exemplo:

proposicao = prop.obterProposicao(prop_id)

Parâmetros:prop_id (String) – Identificador de proposição Retorno:Dicionário de informações sobre proposição Tipo de retorno:  Dictionary

obterTodasProposicoes(**kwargs)

Obtém todas as proposições, filtradas pelos argumentos chaveados

Proposições podem ser projetos de lei, resoluções, medidas provisórias, emendas, pareces. Se não forem passados nenhum filtro, são retornadas todas as proposições que foram apresentadas ou tiveram alguma mudança de situação nos últimos 30 dias.

Exemplo:

for pagina in prop.obterTodasProposicoes(dataInicio=inicio, dataFim=fim):
    for proposicao in pagina:
        print(proposicao)

Parâmetros:

• id (List) – Id de uma ou mais proposições
• siglaTipo (List) – Um ou mais identificador de tipos de proposições; valores válidos podem ser obtidos de /referencias/tiposProposicao
• numero (List) – Um ou mais números atribuídos às proposições
• ano (List) – Um ou mais anos de apresentação das proposições, no formato AAAA
• idDeputadoAutor (List) – Ids de deputados autores de proposições
• autor (String) – Nome de autor de proposições
• siglaPartidoAutor (List) – Uma ou mais siglas de partidos a que pertençam autores de proposições
• idPartidoAutor (String) – Identificador numérico de partido do autor da proposição
• siglaUfAutor (List) – Uma ou mais siglas de Unidades Federativas de autores de proposições
• keywords (List) – Palavras-chaves de proposições
• tramitacaoSenado (Bool) – Verdadeiro para proposições em tramitação no Senado
• dataInicio (String) – Data de início de intervalo de tempo em que tenha havido tramitação de proposições, no formato AAAA-MM-DD
• dataFim (String) – Data de término de intervalo de tempo em que tenha havido tramitação de proposições, no formato AAAA-MM-DD
• dataApresentacaoInicio (String) – Data de início de intervalo de tempo em que tenham sido apresentadas as proposições, no formato AAAA-MM-DD
• dataApresentacaoFim (String) – Data de término de intervalo de tempo em que tenham sido apresentadas as proposições, no formato AAAA-MM-DD
• codSituacao (List) – Identificador numérico de situação de proposição; valores válidos podem ser obtidos em /referencias/situacoesProposicao
• ordem (String) – Sentido de ordenação—asc para ordem ascendente e desc para descendente
• ordenarPor (String) – Nome de campo pelo qual a lista deve ser ordenada: id, codTipo, siglaTipo, numero ou ano

Retorno:

Generator de páginas de listas de proposições

Tipo de retorno:  

Generator

obterTramitacoesProposicao(prop_id)

Obtém o histórico de tramitações da proposição identificada por prop_id

Exemplo:

proposicao_tramitacoes = prop.obterTramitacoesProposicao(prop_id)

Parâmetros:prop_id (String) – Identificador de proposição Retorno:Lista de tramitações de proposição Tipo de retorno:  List

obterVotacoesProposicao(tipo, numero, ano)

Obtém votações pelas quais a proposição identificada por prop_id já passou

Exemplo:

proposicao_votacoes = prop.obterVotacoesProposicao(prop_id)

Parâmetros:

• tipo (String) – Tipo da proposição
• numero (String) – Número da proposição
• ano (String) – Ano da proposição

Retorno:

Lista de votações de proposição

Tipo de retorno:  

List

class legislei.SDKs.CamaraDeputados.entidades.Votacoes

Bases: legislei.SDKs.CamaraDeputados.restful.RESTful

Cliente para obtenção de dados de votações

Essa classe deve ser instanciada para obtenção de dados de votações da Câmara dos Deputados.

Exemplo:

vot = Votacoes()

obterVotacao(vot_id)

Obtém informações sobre a votação identificada por vot_id

Exemplo:

votacao = vot.obterVotacao(vot_id)

Parâmetros:vot_id (String) – Identificador de votação Retorno:Dicionário de informações de votação Tipo de retorno:  Dictionary

obterVotos(vot_id, **kwargs)

Obtém votantes e seus votos da votação identificada por vot_id

Exemplo:

for pagina in vot.obterVotos(vot_id):
    for voto in pagina:
        print(voto)

Parâmetros:vot_id (String) – Identificador de votação Retorno:Generator de páginas de votos Tipo de retorno:  Generator