Mudanças entre as edições de "API-SEADE"
De SEADE
Linha 5: | Linha 5: | ||
=== URI === | === URI === | ||
− | http://api-imp.seade.gov.br | + | http://api-imp.seade.gov.br |
=== Código HTTP de Retorno === | === Código HTTP de Retorno === | ||
Linha 121: | Linha 121: | ||
} | } | ||
} | } | ||
+ | |||
+ | |||
+ | == Nota == | ||
+ | '''GET''' | ||
+ | |||
+ | |||
+ | * '''Path''': /nota | ||
+ | |||
+ | * '''Parâmetros''': código | ||
+ | |||
+ | Caso o código não seja passado, a busca trará todas as notas cadastras. | ||
+ | |||
+ | |||
+ | === Sintaxe de chamada === | ||
+ | |||
+ | curl -X GET "http://api-imp.seade.gov.br/nota" | ||
+ | |||
+ | ou | ||
+ | |||
+ | curl -X GET "http://api-imp.seade.gov.br/nota/{codigo}" | ||
+ | |||
+ | |||
+ | === Retorno JSON === | ||
+ | |||
+ | Exemplo: | ||
+ | |||
+ | { | ||
+ | "nota": { | ||
+ | "codigo": "100", | ||
+ | "descricao": "No modelo de projeção utilizado, ou seja para os anos de 1997 e 1998, foi considerado um ajuste na estrutura etária da população de base, como forma de compensar a subenumeração observada no grupo de 0 a 4 anos, correspondente a Contagem da População de 1996 realizada pela Fundação IBGE." | ||
+ | } | ||
+ | } | ||
+ | |||
== Variável == | == Variável == |
Edição das 19h10min de 4 de outubro de 2013
Índice |
Objetivo
Expor dados estatísticos governamentais do estado de São Paulo.
URI
http://api-imp.seade.gov.br
Código HTTP de Retorno
- Sucesso: 200.
- Erro: 404.
Recursos Disponíveis
Dados
GET
- Path: /dados
- Parâmetros: localidade/variável/ano
* É obrigatório a informação de no mínimo dois parâmetros.
* Coloque zero quando desejar trazer todos os dados de uma categoria.
Sintaxe de chamada
curl -X GET "http://api-imp.seade.gov.br/dados/5/2/2010"
ou
curl -X GET "http://api-imp.seade.gov.br/dados/0/2/2010"
Retorno JSON
Exemplo:
{ "dados": [ { "2010": "516.292", "codigo_localidade": "5", "localidade": "Águas de Lindóia", "nome_localidade_pai": "Região de Governo de Bragança Paulista", "codigo_variavel": "2", "variavel": "Crédito Rural Agricultura", "unidade": "(Em reais de 2011)" } ] }
Fonte
GET
- Path: /fonte
- Parâmetros: código
Caso o código não seja passado, a busca trará todas as fontes.
Sintaxe de chamada
curl -X GET "http://api-imp.seade.gov.br/fonte"
ou
curl -X GET "http://api-imp.seade.gov.br/fonte/{codigo}"
Retorno JSON
Exemplo:
{ "fonte": { "codigo": "10", "nome": "Companhia Energética de São Paulo – CESP." } }
Localidade
GET
- Path: /localidade
- Parâmetros: código
Caso o código não seja passado, a busca trará todas as localidades.
Sintaxe de chamada
curl -X GET "http://api-imp.seade.gov.br/localidade"
ou
curl -X GET "http://api-imp.seade.gov.br/localidade/{codigo}"
Retorno JSON
Exemplo:
{ "localidade": { "codigo": "10", "nome": "Altinópolis", "nivel": "Altinópolis", "codigo_pai": "731", "nome_pai": "Região de Governo de Ribeirão Preto" } }
Nota
GET
- Path: /nota
- Parâmetros: código
Caso o código não seja passado, a busca trará todas as notas cadastras.
Sintaxe de chamada
curl -X GET "http://api-imp.seade.gov.br/nota"
ou
curl -X GET "http://api-imp.seade.gov.br/nota/{codigo}"
Retorno JSON
Exemplo:
{ "nota": { "codigo": "100", "descricao": "No modelo de projeção utilizado, ou seja para os anos de 1997 e 1998, foi considerado um ajuste na estrutura etária da população de base, como forma de compensar a subenumeração observada no grupo de 0 a 4 anos, correspondente a Contagem da População de 1996 realizada pela Fundação IBGE." } }
Variável
GET
- Path: /variavel
- Parâmetros: código
Caso o código não seja passado, a busca trará todas as localidades.
Sintaxe de chamada
curl -X GET "http://api-imp.seade.gov.br/variavel"
ou
curl -X GET "http://api-imp.seade.gov.br/variavel/{codigo}"
Retorno JSON
Exemplo:
{ "variavel": { "codigo": "5", "nome": "Área", "unidade": "(Em km2)", "fonte": "Instituto Brasileiro de Geografia e Estatística–IBGE.", "nota": "A partir de agosto de 2008, os dados referentes à área dos municípios paulistas ..." } }