API


Disponibilizamos, também por meio de Web Service, informações para conhecimento e acompanhamento da sociedade.

api/v1/fontesFontes

Copiar rota




Resposta

[{
"id": "int",
"titulo": "string",
}]
api/v1/fonte/{id}Fonte

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
id int Sim Retorna o registro correspondente ao parâmetro


Resposta

[{
"id": "int",
"titulo": "string",
}]
api/v1/unidadesUnidades

Copiar rota




Resposta

 [{
"id": "int",
"titulo": "string",
}]
api/v1/unidade/{id}Unidade

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
id int Sim Retorna o registro correspondente ao parâmetro


Resposta

{
"id": "int",
"titulo": "string",
}
api/v1/periodicidadesPeriodicidades

Copiar rota




Resposta

[{
"id": "int",
"titulo": "string",
}]
api/v1/periodicidade/{id}Periodicidade

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
id int Sim Retorna o registro correspondente ao parâmetro


Resposta

{
"id": "int",
"titulo": "string",
}
api/v1/indicadoresIndicadores

Copiar rota




Resposta

[{
"id": "int",
"titulo": "string",
}]
api/v1/indicador/{id}Indicador

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
id int Sim Retorna o registro correspondente ao parâmetro


Resposta

 {
"id": "int",
"titulo": "string",
}
api/v1/temasTemas

Copiar rota




Resposta

 [{
"id": "int",
"tema": "string",
"tema_id": "int",
"imagem": "string",
"tipo": "int",
"subTemas": [
"id": "int",
"tema": "string",
"tema_id": "int",
"imagem": "string",
"tipo": "int",
"subTemas": []
]
}]
api/v1/tema/{id}Tema

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
id int Sim Retorna o registro correspondente ao parâmetro


Resposta

{
"id": "int",
"tema": "string"
}
api/v1/valores-series/{serie_id}/{abrangencia}Valores Series

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
serie_id int Sim Id da série
abrangência int Sim Abrangência da Série. Ex: 1 - País | 2 - Região | 3 - UF | 4 - Município
inicial* date Não Para periodicidade Anual YYYY | Para periodicidade YYYY-MM | Para as demais YYYY-MM-DD
final* date Não Para periodicidade Anual YYYY | Para periodicidade YYYY-MM | Para as demais YYYY-MM-DD
* Inserindo o período inicial se torna obrigatório inserir o período final


Resposta

[{
"cod":"int"
"periodo":"date"
"sigla":"string"
"valor":"double"
}]
api/v1/valores-series-por-regioes/{serie_id}/{abrangencia}/{regioes}Valores Séries por Regiões

Copiar rota


Parâmetros

Parâmetro Tipo Obrigatorio Descrição
serie_id int Sim Id da série
abrangência int Sim Abrangência da Série. Ex: 1 - País | 2 - Região | 3 - UF | 4 - Município
regioes string Sim A Sigla no caso de País | Região | UF. Ex: BRA | SE | RJ. O código do IBGE no caso de municípios Ex: 3304557 
inicial* date Não Para periodicidade Anual YYYY | Para periodicidade YYYY-MM | Para as demais YYYY-MM-DD
final* date Não Para periodicidade Anual YYYY | Para periodicidade YYYY-MM | Para as demais YYYY-MM-DD
* Inserindo o período inicial se torna obrigatório inserir o período final


Resposta

[{
"cod":"int"
"periodo":"date"
"sigla":"string"
"valor":"double"
}]
api/v1/series/{tema_id}Séries

Copiar rota


Parâmetros

ParâmetroTipoObrigatorioDescrição
tema_idintNãoRetorna os registros correspondentes ao parâmetro


Resposta

[{
"id": "int",
"titulo": "string",
}]
api/v1/serie/{id}Série

Copiar rota


Parâmetros

ParâmetroTipoObrigatorioDescrição
idintSimRetorna o registro correspondente ao parâmetro


Resposta

{
"id": "int",
"titulo": "string",
}