legislei.SDKs.CamaraDeputados.restful module

class legislei.SDKs.CamaraDeputados.restful.RESTful(api_section)

Bases: legislei.SDKs.CamaraDeputados.api.Base

Classe base de operações da API REST da Câmara de Deputados

Essa classe contém métodos base para chamadas da API REST da Câmera dos Deputados, herdade pelas demais classes do pacote.

Parâmetros:api_section (String) – Seção da API da CM (i.g. deputados, eventos, etc)

getAPISingleRequest(param_id, param_page='')

Retorna dados de um endpoint

Retorna os dados de uma única chamada à API. Normalmente utilizada para buscar dados de uma entidade definida pelo id passado em param_id, como, por exemplo, um deputado ou uma proposição.

Parâmetros:

• param_id (String) – Id da entidade
• param_page (String) – Subpágina da API

Retorno:

Dados da API

Tipo de retorno:  

Dictionary

Raises:

CamaraDeputadosConnectionError, CamaraDeputadosInvalidResponse

getJSONFrom(uri, **kwargs)

Obtém dados diretamente da URL fornecida

Esse método recebe uma URL e processa o JSON dela. Recebe parâmetros com chaves como parâmetros GET da chamada.

Parâmetros:uri (String) – URL de chamada Retorno:Dados JSON processados Tipo de retorno:  Dictionary Raises:CamaraDeputadosConnectionError, CamaraDeputadosInvalidResponse

runThroughAllPages(*args, **kwargs)

Obtém todas as páginas de um endpoint

Essa função obtém todas as páginas de um endpoint definido pela seção definida no construtor da classe, bem como a lista argumentos passados para essa função. Essa função utiliza o parâmetro pagina disponível em todas as chamadas da API da Câmara dos Deputados que utilizam paginação. Retorna um Generator para cada página obtida.

Retorno:Generator de páginas da chamada Tipo de retorno:  Generator Raises:CamaraDeputadosConnectionError, CamaraDeputadosInvalidResponse