Mudanças entre as edições de "API-SEADE"

De SEADE
Ir para: navegação, pesquisa
Linha 10: Linha 10:
  
 
== Localidade ==
 
== Localidade ==
GET
+
'''GET'''
  
 
Path: /localidade
 
Path: /localidade
Linha 18: Linha 18:
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
curl -X GET "http://api-imp.seade.gov.br/localidade/{codigo}"
+
curl -X GET "http://api-imp.seade.gov.br/localidade/{codigo}"
  
 
=== Exemplo ===
 
=== Exemplo ===
  
curl -X GET "http://api-imp.seade.gov.br/localidade/10"
+
curl -X GET "http://api-imp.seade.gov.br/localidade/10"
  
=== Status Code de Retorno ===
+
=== Código HTTP de Retorno ===
  
 
Sucesso: 200.
 
Sucesso: 200.

Edição das 11h48min de 3 de outubro de 2013

Índice

Objetivo

Expor dados estatísticos governamentais do estado de São Paulo.

URI

http://api-imp.seade.gov.br

Recursos Disponíveis

Localidade

GET

Path: /localidade

Parâmetros: código*

Sintaxe de chamada

curl -X GET "http://api-imp.seade.gov.br/localidade/{codigo}"

Exemplo

curl -X GET "http://api-imp.seade.gov.br/localidade/10"

Código HTTP de Retorno

Sucesso: 200.

Erro: 404.

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"
   }
}

Variável

GET

Path: /variavel

Parâmetros: código

Exemplo de chamada

curl -X GET "http://api-imp.seade.gov.br/consulta/5"

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 ..."
   }
}

Consulta

GET

Path: /consulta

Parâmetros: localidade/variável/ano

Exemplo de chamada

curl -X GET "http://api-imp.seade.gov.br/consulta/16/15/0"

Retorno JSON

Exemplo:

{
   "consulta": [
       {
           "loc_cod": "16",
           "loc_nome": "Americana",
           "unid_nome": "(Por mil nascidos vivos ou mortos)",
           "nome_pai": "Região Metropolitana de Campinas",
           "var_cod": "15",
           "var_nome": "Teatros – Salas Disponíveis",
           "d_1995": "2",
           "d_1997": "2",
           "d_2000": "2",
           "d_2003": "1"
       },
       {
           "loc_cod": "16",
           "loc_nome": "Americana",
           "unid_nome": "(Por mil nascidos vivos ou mortos)",
           "nome_pai": "Região de Governo de Campinas",
           "var_cod": "15",
           "var_nome": "Teatros – Salas Disponíveis",
           "d_1995": "2",
           "d_1997": "2",
           "d_2000": "2",
           "d_2003": "1"
       }
   ]
}