https://github.com/interlegis/interlegis.portalmodelo.api

API de dados abertos do Portal Modelo
https://github.com/interlegis/interlegis.portalmodelo.api

Last synced: 5 months ago
JSON representation

API de dados abertos do Portal Modelo

• Host: GitHub
• URL: https://github.com/interlegis/interlegis.portalmodelo.api
• Owner: interlegis
• Created: 2014-06-10T21:49:15.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2019-08-22T18:52:08.000Z (almost 7 years ago)
• Last Synced: 2024-04-16T02:09:00.402Z (about 2 years ago)
• Language: Python
• Size: 46.9 KB
• Stars: 1
• Watchers: 21
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst

Awesome Lists containing this project

README

          
***************************

interlegis.portalmodelo.api

***************************

.. contents:: Conteúdo

   :depth: 2

Introdução

==========

Este pacote fornece um configlet do painel de controle do Plone para cadastar

os dados básicos da Casa Legislativa:

* Nome do órgão

* Tipo do órgão

* Endereço

* CEP

* Cidade

* Estado

* CNPJ

* Telefone

* Email

O pacote também fornece duas views para consulta de informação em formato

JSON.

Detalhes da implementação

=========================

Nome do órgão

-------------

O campo nome do órgão deve ficar sempre sincronizado com o título do portal.

A implementação é simples: no render do formulario o valor do campo é

atualizado com o valor da propriedade ``title`` do portal::

    def updateWidgets(self):

        ...

        portal = api.portal.get()

        self.widgets['title'].value = portal.title

Na hora de guardar o formulario, usamos um ``invariant`` como hook para

colocar essa misma informação de volta::

    @invariant

    def update_portal_title_hook(data):

        portal = api.portal.get()

        portal.title = data.title

Desse jeito não importa se o usuário modifica o nome do órgão num formulario

ou no outro.

Tipo do órgão

-------------

O tipo de órgão é um vocabulário controlado com os seguinte valores possíveis:

* Assembleia Legislativa

* Câmara dos Deputados

* Câmara Legislativa

* Câmara Municipal

* Outro

* Senado Federal

* Tribunal de Contas da União

* Tribunal de Contas Estadual

* Tribunal de Contas Municipal

JSON API

--------

O pacote fornece duas views na raiz do portal para consulta de informação em

formato JSON: ``@@portalmodelo-json`` e ``@@transparency-json``.

``@@portalmodelo-json``

^^^^^^^^^^^^^^^^^^^^^^^

Disponibiliza a informação básica da Casa Legislativa que foi cadastrada no

configlet do painel de controle do portal::

    {

        "address": "Rua Comendador Roberto Ugolini, 20",

        "city": "Mooca",

        "email": "foo@bar.com",

        "id": "62.863.444/0001-08",

        "kind": "assembleia-legislativa",

        "postal_code": "03125-010",

        "state": "SP",

        "telephone": "+55 11 2271-2000",

        "title": "Portal Modelo"

    }

``@@transparency-json``

^^^^^^^^^^^^^^^^^^^^^^^^

Disponibiliza o conteúdo publicado dentro da estrutura de pastas definida para

cumprir com a Lei de Transparência::

    {

        "acompanhamento": [],

        "despesas": [

            {

                "creation_date": "2014-04-23T22:21:53-03:00",

                "description": "Arquivo em formato CSV.",

                "modification_date": "2014-04-23T22:21:53-03:00",

                "title": "Despesas de 201401",

                "uri": "http://localhost:8080/portal/transparencia/despesas/despesas-de-201401"

            }

        ],

        "licitacoes": [],

        "receitas": [],

        "transferencias": []

    }