Mudanças entre as edições de "Modelo de acesso aos dados publicados no banco de dados da Fênix (Tempo Real e Publicações)"
(14 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
Linha 2: | Linha 2: | ||
'''<big><font color="blue">PDTR (Publicação de Dados em Tempo Real)</font></big>''' | '''<big><font color="blue">PDTR (Publicação de Dados em Tempo Real)</font></big>''' | ||
− | O P.D.T.R. possui 3 tipos de relatórios: | + | O P.D.T.R. possui 3 tipos de relatórios: Despesas, Receitas e Licitações.<br> |
Para efetuar pesquisa de um determinado município, e deixar que o usuário continue a pesquisa:<br /> | Para efetuar pesquisa de um determinado município, e deixar que o usuário continue a pesquisa:<br /> | ||
http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880 | http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880 | ||
− | *(Substituindo na URL os parâmetros uf e | + | Para efetuar a pesquisa de um determinado órgão, e deixar que o usuário continue a pesquisa:<br /> |
+ | *'''Para Despesas (Empenhos)'''<br /> | ||
+ | http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10 <br /> ou <br /> http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10&tipoConsulta=empenho | ||
+ | *'''Para Receitas'''<br /> | ||
+ | http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10&tipoConsulta=receita | ||
+ | *'''Para Licitações'''<br /> | ||
+ | http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10&tipoConsulta=licitacao | ||
+ | *(Substituindo na URL os parâmetros uf, id e orgao, onde uf é a sigla do estado, o id é o código de identificação (''município/câmara'') e o órgão ("orgao") é código do órgão que deseja que fique na caixa de selação, os códigos dos municípios e órgãos são os cadastrados pela Fênix Processamento de Dados, e estão disponíveis no sistema CONTAB);<br /> | ||
Outra forma de ser efetuada a consulta é montando a URL para já executar a consulta e retornar os dados (API/WebService), para isso ela deve ser informada da seguinte forma: | Outra forma de ser efetuada a consulta é montando a URL para já executar a consulta e retornar os dados (API/WebService), para isso ela deve ser informada da seguinte forma: | ||
− | http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/pdf | + | http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/pdf |
Parâmetros da URL:<br /> | Parâmetros da URL:<br /> | ||
*'''Lançamento Contábil''' = PDTR (LancamentoContabil)<br /> | *'''Lançamento Contábil''' = PDTR (LancamentoContabil)<br /> | ||
− | *'''Tipo de relatório''': empenho, ReceitaMovimentacao ( | + | *'''Tipo de relatório''': empenho (.../pdtr/index.php/LancamentoContabil/empenho/municipio...), ReceitaMovimentacao (.../pdtr/index.php/receita-movimentacao/), Licitacao (.../pdtr/index.php/licitacao/...)<br /> |
*'''Município''' (código do município, cadastrado pela Fênix)<br /> | *'''Município''' (código do município, cadastrado pela Fênix)<br /> | ||
*'''Órgão''' (código do órgão do município)<br /> | *'''Órgão''' (código do órgão do município)<br /> | ||
*'''Ano''' (ano)<br /> | *'''Ano''' (ano)<br /> | ||
− | *'''Tipo de arquivo''': pdf | html | excel | json (padrão)<br /> | + | *'''Mês''' (mes) - <font color="red">(utilizado apenas na receita) </font><br /> |
+ | *'''Tipo de arquivo (Retorno)''': pdf | html | excel | json (padrão)<br /> | ||
http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/{tipoRelatorio}/municipio/{codMunicipio}/orgao/{codOrgao}/ano/{ano}/{tipo_arquivo} | http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/{tipoRelatorio}/municipio/{codMunicipio}/orgao/{codOrgao}/ano/{ano}/{tipo_arquivo} | ||
− | Logo, para se obter os empenhos basta informar a URL da forma escrita abaixo, de acordo com cada tipo de retorno dos dados(tipo_arquivo):<br /> | + | Logo, para se obter os empenhos (Despesas) basta informar a URL da forma escrita abaixo, de acordo com cada tipo de retorno dos dados(tipo_arquivo):<br /> |
− | '''PDF''': http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/pdf <font color="red">( | + | '''PDF''': http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/pdf <font color="red">(Relatório com alto consumo de processamento) </font><br /> |
− | '''Excel''': http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/excel | + | '''Excel''': http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/excel <br /> |
'''JSON''': http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015 <br /> | '''JSON''': http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015 <br /> | ||
− | '''HTML''': http://www.fenix.com.br/pdtr/index.php/lancamento-contabil/empenho/municipio/73770/orgao/02/ano/2015/html < | + | '''HTML''': http://www.fenix.com.br/pdtr/index.php/lancamento-contabil/empenho/municipio/73770/orgao/02/ano/2015/html |
+ | <br /><br /> | ||
+ | Logo, para se obter as receitas basta informar a URL da forma escrita abaixo, de acordo com o municipio/orgao/ano/mes:<br /> | ||
+ | '''PDF''': http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01/pdf <br /> | ||
+ | '''Excel''': http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01/excel <br /> | ||
+ | '''JSON''': http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01 <br /> | ||
+ | '''HTML''': http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01/html | ||
+ | <br /><br /> | ||
+ | Logo, para se obter as licitações basta informar a URL da forma escrita abaixo, de acordo com o municipio/orgao/ano:<br /> | ||
+ | '''PDF''': http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015/pdf <br /> | ||
+ | '''Excel''': http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015/excel <br /> | ||
+ | '''JSON''': http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015 <br /> | ||
+ | '''HTML''': http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015/html | ||
<br /><br /> | <br /><br /> | ||
'''<big><font color="blue">Para os Anexos das metas/riscos | Orçamento | PPA - Plano plurianual | Cronograma de ações | L.D.O. (menu superior )</font></big>''' | '''<big><font color="blue">Para os Anexos das metas/riscos | Orçamento | PPA - Plano plurianual | Cronograma de ações | L.D.O. (menu superior )</font></big>''' | ||
Linha 31: | Linha 51: | ||
*Plano Plurianual (PPA) | *Plano Plurianual (PPA) | ||
**http://www.fenix.com.br/pdtr/index.php/planoPlurianual/filter?uf=go&id=75940 (Para PPA) | **http://www.fenix.com.br/pdtr/index.php/planoPlurianual/filter?uf=go&id=75940 (Para PPA) | ||
+ | *Balanço Geral | ||
+ | **http://www.fenix.com.br/pdtr/index.php/balancoGeral/filter?uf=go&id=75940 (Para o Balanço Geral) | ||
(Substituindo na URL os parâmetros uf e id, onde uf é a sigla do estado e o id é o código de identificação junto à Fênix Processamento de Dados); | (Substituindo na URL os parâmetros uf e id, onde uf é a sigla do estado e o id é o código de identificação junto à Fênix Processamento de Dados); | ||
Deste modelo o usuário irá efetuar a seleção de qual ano será efetuada a pesquisa dos documentos;<br /><br /> | Deste modelo o usuário irá efetuar a seleção de qual ano será efetuada a pesquisa dos documentos;<br /><br /> | ||
Outra forma para se efetuar a consulta é informando a URL da seguinte maneira:<br /><br /> | Outra forma para se efetuar a consulta é informando a URL da seguinte maneira:<br /><br /> | ||
− | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/anexos/municipio/73770/ano/2011 | + | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/anexos/municipio/73770/ano/2011 <br /> |
− | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/orcamento/municipio/73770/ano/2015 | + | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/orcamento/municipio/73770/ano/2015 <br /> |
− | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/planoPlurianual/municipio/73770/ano/2014 | + | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/planoPlurianual/municipio/73770/ano/2014 <br /> |
− | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/cronograma/municipio/73770/ano/2015 | + | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/cronograma/municipio/73770/ano/2015 <br /> |
− | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/ldo/municipio/73770/ano/2015 < | + | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/ldo/municipio/73770/ano/2015 <br /> |
− | + | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/balancoGeral/municipio/73770/ano/2015 <br /> | |
Onde:<br /> | Onde:<br /> | ||
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/{tipo de arquivo}/municipio/{codMunicipio}/ano/{ano} | http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/{tipo de arquivo}/municipio/{codMunicipio}/ano/{ano} | ||
Linha 52: | Linha 74: | ||
*Municipio: /municipio/{código do município que é informado pela Fênix}<br /> | *Municipio: /municipio/{código do município que é informado pela Fênix}<br /> | ||
*Ano: /ano/{ano de referência dos arquivos} | *Ano: /ano/{ano de referência dos arquivos} | ||
− | + | Ao passar um link pesquisando o arquivo de um municipio, exemplo: http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/loa/municipio/75940/ano/2015 <br /> | |
− | + | O retorno será um array contendo parte de um link com o id, em sua última posição, que deverá ser passado para ser efetuado o download do arquivo: <br /> | |
+ | A montagem do link final será: http://www.fenix.com.br/pdtr/index.php/arquivo/cliente/{id de retorno no link do array}/download<br /> | ||
+ | Exemplo: http://www.fenix.com.br/pdtr/index.php/arquivo/cliente/661/download | ||
+ | <br /> | ||
'''<big><font color="blue">Publicações da LRF e do TCU</font></big>''' | '''<big><font color="blue">Publicações da LRF e do TCU</font></big>''' | ||
*'''TCU''': http://www.fenix.com.br/pdtr/index.php/tcu/filter?uf=go&id=75940 | *'''TCU''': http://www.fenix.com.br/pdtr/index.php/tcu/filter?uf=go&id=75940 | ||
Linha 60: | Linha 85: | ||
(Substituindo na URL os parâmetros uf e id, onde uf é a sigla do estado e o id é o código de identificação junto à Fênix Processamento de Dados); | (Substituindo na URL os parâmetros uf e id, onde uf é a sigla do estado e o id é o código de identificação junto à Fênix Processamento de Dados); | ||
− | |||
− | |||
− | |||
− | |||
− |
Edição atual tal como às 11h05min de 14 de março de 2018
Sobre as URL temos como padrão sempre o endereço para acesso inicial: http://www.fenix.com.br/pdtr/index.php/
PDTR (Publicação de Dados em Tempo Real)
O P.D.T.R. possui 3 tipos de relatórios: Despesas, Receitas e Licitações.
Para efetuar pesquisa de um determinado município, e deixar que o usuário continue a pesquisa:
http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880
Para efetuar a pesquisa de um determinado órgão, e deixar que o usuário continue a pesquisa:
- Para Despesas (Empenhos)
http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10
ou
http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10&tipoConsulta=empenho
- Para Receitas
http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10&tipoConsulta=receita
- Para Licitações
http://www.fenix.com.br/pdtr/index.php/pdtr/filter?uf=to&id=77880&orgao=10&tipoConsulta=licitacao
- (Substituindo na URL os parâmetros uf, id e orgao, onde uf é a sigla do estado, o id é o código de identificação (município/câmara) e o órgão ("orgao") é código do órgão que deseja que fique na caixa de selação, os códigos dos municípios e órgãos são os cadastrados pela Fênix Processamento de Dados, e estão disponíveis no sistema CONTAB);
Outra forma de ser efetuada a consulta é montando a URL para já executar a consulta e retornar os dados (API/WebService), para isso ela deve ser informada da seguinte forma:
http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/pdf
Parâmetros da URL:
- Lançamento Contábil = PDTR (LancamentoContabil)
- Tipo de relatório: empenho (.../pdtr/index.php/LancamentoContabil/empenho/municipio...), ReceitaMovimentacao (.../pdtr/index.php/receita-movimentacao/), Licitacao (.../pdtr/index.php/licitacao/...)
- Município (código do município, cadastrado pela Fênix)
- Órgão (código do órgão do município)
- Ano (ano)
- Mês (mes) - (utilizado apenas na receita)
- Tipo de arquivo (Retorno): pdf | html | excel | json (padrão)
http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/{tipoRelatorio}/municipio/{codMunicipio}/orgao/{codOrgao}/ano/{ano}/{tipo_arquivo}
Logo, para se obter os empenhos (Despesas) basta informar a URL da forma escrita abaixo, de acordo com cada tipo de retorno dos dados(tipo_arquivo):
PDF: http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/pdf (Relatório com alto consumo de processamento)
Excel: http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015/excel
JSON: http://www.fenix.com.br/pdtr/index.php/LancamentoContabil/empenho/municipio/73770/orgao/02/ano/2015
HTML: http://www.fenix.com.br/pdtr/index.php/lancamento-contabil/empenho/municipio/73770/orgao/02/ano/2015/html
Logo, para se obter as receitas basta informar a URL da forma escrita abaixo, de acordo com o municipio/orgao/ano/mes:
PDF: http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01/pdf
Excel: http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01/excel
JSON: http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01
HTML: http://www.fenix.com.br/pdtr/index.php/receita-movimentacao/municipio/73770/orgao/02/ano/2015/mes/01/html
Logo, para se obter as licitações basta informar a URL da forma escrita abaixo, de acordo com o municipio/orgao/ano:
PDF: http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015/pdf
Excel: http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015/excel
JSON: http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015
HTML: http://www.fenix.com.br/pdtr/index.php/licitacao/municipio/73770/ano/2015/html
Para os Anexos das metas/riscos | Orçamento | PPA - Plano plurianual | Cronograma de ações | L.D.O. (menu superior )
- Anexos das Metas e Riscos Fiscais
- http://www.fenix.com.br/pdtr/index.php/anexo/filter?uf=go&id=75940 (Para os anexos e metas )
- Orçamento (LOA)
- Lei de Diretrizes Orçamentárias (LDO)
- Plano Plurianual (PPA)
- Balanço Geral
- http://www.fenix.com.br/pdtr/index.php/balancoGeral/filter?uf=go&id=75940 (Para o Balanço Geral)
(Substituindo na URL os parâmetros uf e id, onde uf é a sigla do estado e o id é o código de identificação junto à Fênix Processamento de Dados);
Deste modelo o usuário irá efetuar a seleção de qual ano será efetuada a pesquisa dos documentos;
Outra forma para se efetuar a consulta é informando a URL da seguinte maneira:
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/anexos/municipio/73770/ano/2011
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/orcamento/municipio/73770/ano/2015
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/planoPlurianual/municipio/73770/ano/2014
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/cronograma/municipio/73770/ano/2015
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/ldo/municipio/73770/ano/2015
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/balancoGeral/municipio/73770/ano/2015
Onde:
http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/{tipo de arquivo}/municipio/{codMunicipio}/ano/{ano}
Parâmetros:
- Tipo de Arquivo:
- ANEXOS (anexos) = para os arquivos das metas e riscos fiscais;
- ORCAMENTO (orcamento) = para os arquivos da L.O.A. (Lei Orçamentária Anual);
- PPA (planoPlurianual) = para os arquivos do PPA (Plano Plurianual);
- CRONOGRAMA (cronograma) = para o arquivo Cronograma de Ações - Portaria 828/2011;
- LDO (ldo) = para os arquivos da L.D.O. (Lei de Diretrizes Orçamentárias);
- ANEXOS (anexos) = para os arquivos das metas e riscos fiscais;
- Municipio: /municipio/{código do município que é informado pela Fênix}
- Ano: /ano/{ano de referência dos arquivos}
Ao passar um link pesquisando o arquivo de um municipio, exemplo: http://www.fenix.com.br/pdtr/index.php/arquivo/pagina/loa/municipio/75940/ano/2015
O retorno será um array contendo parte de um link com o id, em sua última posição, que deverá ser passado para ser efetuado o download do arquivo:
A montagem do link final será: http://www.fenix.com.br/pdtr/index.php/arquivo/cliente/{id de retorno no link do array}/download
Exemplo: http://www.fenix.com.br/pdtr/index.php/arquivo/cliente/661/download
Publicações da LRF e do TCU
(Substituindo na URL os parâmetros uf e id, onde uf é a sigla do estado e o id é o código de identificação junto à Fênix Processamento de Dados);