Introdução
Bem vindo a API do SimCAQ. Esta documentação reflete o estado da API em desenvolvimento. Alterações as respostas podem ocorrer.
Parâmetros da URL
Os parâmetros desta API para as requisições do tipo GET terão campos, parâmetros e valores explicitados da seguinte forma:
campos
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
Exemplo:
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Retorna o estado | /api/v1/city?dims=state |
A não ser se específicado, não há limite para o número de parâmetros que cada campo aceita. Separe os parâmetros por vírgula (,) e os campos com &: /api/v1/enrollment?dims=state,city&filter=state:41
Filtros
Os filtros são um parâmetro da URL para os indicadores do SimCAQ que permitem filtar a resposta dos mesmos. Os filtros podem aceitar um ou mais valores com a seguinte sintaxe:
Valor único /api/v1/enrollment?filter=state:41
Múltilpos valores /api/v1/enrollment?filter=region:[1,2]
Você pode utilizar quantos filtros quiser ao mesmo tempo em uma única requisição.
Formatos da resposta
Você pode obter as respostas da API nos formatos JSON, CSV e XML. Por padrão, a API retorna em json.
CSV
Utilize o campo format na URL: ?format=csv
XML
Utilize o campo format na URL: ?format=XML
Anos educacionais (education level short X school year)
Esta rota retorna os níveis educacionais resumidos incluindo os anos escolares pertencentes ao nível.
GET https://simcaq.c3sl.ufpr.br/api/v1/education_years
{
"result": [
{
"id": 1,
"name": "Creche",
"schoolYears": [
{
"id": 11,
"name": "Creche - Menor de 1 ano"
},
{
"id": 12,
"name": "Creche - 1 ano"
},
{
"id": 13,
"name": "Creche - 2 anos"
},
{
"id": 14,
"name": "Creche - 3 anos"
}
]
},
{
"id": 2,
"name": "Pré-Escola",
"schoolYears": [
{
"id": 21,
"name": "Pré-escola - 4 anos"
},
{
"id": 22,
"name": "Pré-escola - 5 anos"
}
]
},
...
}Região
Obter todas as regiões
GET https://simcaq.c3sl.ufpr.br/api/v1/region
{
"result": [
{
"id": 1,
"name": "Norte"
},
...
]
}Parâmetros
search
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| name | String | Retorna as regiões cujo nome contém a string especificada. Case insensitive | /api/v1/region?search=name:nor |
O resultado da busca será este
{
"result":[
{
"id":1,
"name":"Norte"
},
{
"id":2,
"name":"Nordeste"
}
]
}filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| id | Integer | Retorna a região com o id id |
/api/v1/region?filter=id:1 |
Estado
Obter todos os estados
GET https://simcaq.c3sl.ufpr.br/api/v1/state
{
"result": [
{
"id": 11,
"region_id": 1,
"name": "Rondônia",
"abbreviation": "RO"
},
...
]
}Parâmetros
search
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| name | String | Retorna os estados cujo nome contém a string especificada. Case insensitive | /api/v1/state?search=name:par |
O resultado da busca será este
{
"result":
[
{
"id":15,
"region_id":1,
"name":"Pará",
"abbreviation":"PA"
},
{
"id":25,
"region_id":2,
"name":"Paraíba",
"abbreviation":"PB"
},
{
"id":41,
"region_id":4,
"name":"Paraná",
"abbreviation":"PR"
}
]
}filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| id | Integer | Retorna o estado com o id id |
/api/v1/state?filter=id:1 |
| region | Integer | Retorna os estados que pertencem a região com id region |
/api/v1/state?filter=region:4 |
Cidade
Obter todas as cidades
GET https://simcaq.c3sl.ufpr.br/api/v1/city
{
"result": [
{
"id":1200013,
"name":"Acrelândia",
"state_id":12
},
...
]
}Parâmetros
search
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| name | String | Retorna as cidades cujo nome contém a string especificada. Case insensitive | /api/v1/state?search=name:miguel |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| id | Integer | Retorna a cidade com o id id |
/api/v1/city?filter=id:1 |
| state | Integer | Retorna as cidades que pertencem ao estado com id state |
/api/v1/city?filter=state:11 |
Escola
Obter todas as escolas
GET https://simcaq.c3sl.ufpr.br/api/v1/school
{
"result": [
{
"id":41000021,
"year":2007,
"state_id":41,
"city_id":4100608
},
...
]
}Parâmetros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| id | Integer | Retorna a escola com o id id |
/api/v1/school?filter=id:1 |
| city | Integer | Retorna as escolas que pertencem a cidade com id estado |
/api/v1/school?filter=state:11 |
| state | Integer | Retorna as escolas que pertencem ao estado com id state |
/api/v1/school?filter=state:11 |
Indicador: IDHM
Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| idhm_level | Adiciona ao resultado usando o campo do Nível de IDHM | /api/v1/idhm?dims=idhm_level |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/idhm?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/idhm?dims=city |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/idhm?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/idhm?filter=city:4106902 |
| idhm_level | Integer | Filtra o resultado usando o campo do Nível de IDHM | /api/v1/idhm?filter=idhm_level:2 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/idhm?filter=min_year:2000 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/idhm?filter=max_year:2010 |
GET https://simcaq.c3sl.ufpr.br/api/v1/idhm?dims=state&filter=min_year:2000,state:41
{
"result":[
{"total":0.749,"year":2010,"state_id":41,"state_name":"Paraná"},
{"total":0.65,"year":2000,"state_id":41,"state_name":"Paraná"}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhm/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhm/years
{
"result":[
{"year":1991},
{"year":2000},
{"year":2010}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhm/source
{
"result": [
{
"source": "Atlas do Desenvolvimento Humano/PNUD"
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhm/idhm_level
{
"result":[
{"id":null,"name":"Não classificada"},
{"id":1,"name":"Muito Baixa"},
{"id":2,"name":"Baixo"},
{"id":3,"name":"Médio"},
{"id":4,"name":"Alto"},
{"id":5,"name":"Muito Alto"}
]
}Indicador: IDHMR
Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Adiciona ao resultado o campo do estado | /api/v1/idhmr?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/idhmr?dims=city&filter=state:41 |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/idhmr?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/idhmr?filter=city:4106902 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/idhmr?filter=min_year:2000 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/idhmr?filter=max_year:2010 |
GET https://simcaq.c3sl.ufpr.br/api/v1/idhmr?dims=state&filter=min_year:2000,state:41
{
"result":[
{"total":0.757,"year":2010,"state_id":41,"state_name":"Paraná"},
{"total":0.704,"year":2000,"state_id":41,"state_name":"Paraná"}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhmr/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhmr/years
{
"result":[
{"year":1991},
{"year":2000},
{"year":2010}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhmr/source
{
"result": [
{
"source": "Atlas do Desenvolvimento Humano/PNUD"
}
]
}Indicador: IDHML
Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Adiciona ao resultado o campo do estado | /api/v1/idhml?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/idhml?dims=city&filter=state:41 |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/idhml?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/idhml?filter=city:4106902 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/idhml?filter=min_year:2000 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/idhml?filter=max_year:2010 |
GET https://simcaq.c3sl.ufpr.br/api/v1/idhml?dims=state&filter=min_year:2000,state:41
{
"result":[
{"total":0.83,"year":2010,"state_id":41,"state_name":"Paraná"},
{"total":0.747,"year":2000,"state_id":41,"state_name":"Paraná"}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhml/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhml/years
{
"result":[
{"year":1991},
{"year":2000},
{"year":2010}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhml/source
{
"result": [
{
"source": "Atlas do Desenvolvimento Humano/PNUD"
}
]
}Indicador: IDHME
Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Adiciona ao resultado o campo do estado | /api/v1/idhme?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/idhme?dims=city&filter=state:41 |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/idhme?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/idhme?filter=city:4106902 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/idhme?filter=min_year:2000 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/idhme?filter=max_year:2010 |
GET https://simcaq.c3sl.ufpr.br/api/v1/idhme?dims=state&filter=min_year:2000,state:41
{
"result":[
{"total":0.668,"year":2010,"state_id":41,"state_name":"Paraná"},
{"total":0.522,"year":2000,"state_id":41,"state_name":"Paraná"}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhme/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhme/years
{
"result":[
{"year":1991},
{"year":2000},
{"year":2010}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/idhme/source
{
"result": [
{
"source": "Atlas do Desenvolvimento Humano/PNUD"
}
]
}Indicador: Pib per Capita
Para obter Pib per Capita
GET https://simcaq.c3sl.ufpr.br/api/v1/pibpercapita
{
"result":[
{"total":20.371641939931667,"year":2010},
{"total":22.748717239190093,"year":2011},
{"total":24.821549777645792,"year":2012},
{"total":26.517183939639885,"year":2013},
{"total":28.49589012686903,"year":2014}
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/pibpercapita?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/pibpercapita?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/api/v1/pibpercapita?dims=city |
|
| income_level | Adiciona ao resultado o campo da nível da renda per capitada | /api/v1/pibpercapita?dims=income_level |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/pibpercapita?filter=region:2 |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/pibpercapita?filter=state:41 |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/api/v1/pibpercapita?filter=city:4106902 |
|
| income_level | Adiciona ao resultado o campo de nível de renda per capita | /api/v1/pibpercapita?filter=income_level:1 |
|
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/pibpercapita?filter=min_year:2000 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/pibpercapita?filter=max_year:2010 |
GET https://simcaq.c3sl.ufpr.br/api/v1/pibpercapita?filter=region:4,income_level:1&dims=state
{
"result":[
{"state_name":"Santa Catarina","total":4.644697016620213,"year":2013},
{"state_name":"Santa Catarina","total":5.705628521667862,"year":2014}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/pibpercapita/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/pibpercapita/years
{
"result":[
{"year":2010},
{"year":2011},
{"year":2012},
{"year":2013},
{"year":2014}
]
}Nível de renda per capita disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/pibpercapita/income_level
{
"result":[
{"id":1,"name":"1º quintil – 20% menores"},
{"id":2,"name":"2º quintil"},
{"id":3,"name":"3º quintil"},
{"id":4,"name":"4º quintil"},
{"id":5,"name":"5º quintil – 20% maiores"}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/pibpercapita/source
{
"result": [
{
"source": "IBGE"
}
]
}Indicador: População
Para obter População
GET https://simcaq.c3sl.ufpr.br/api/v1/population
{
"result":[
{"total":206081432,"year":2016}
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/population?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/population?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/api/v1/population?dims=city |
|
| city_size | Adiciona ao resultado o campo de porte de município | /api/v1/population?dims=city_size |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/population?filter=region:2 |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/population?filter=state:41 |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/api/v1/population?filter=city:4106902 |
|
| city_size | Adiciona ao resultado o campo de nível de porte de município | /api/v1/population?filter=city_size:1 |
|
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/population?filter=min_year:2000 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/population?filter=max_year:2010 |
GET https://simcaq.c3sl.ufpr.br/api/v1/population?filter=city_size:1,region:1&dims=state
{
"result":[
{"state_name":"Amapá","total":4655,"year":2016},
{"state_name":"Amazonas","total":4660,"year":2016},
{"state_name":"Pará","total":3233,"year":2016},
{"state_name":"Rondônia","total":18212,"year":2016},
{"state_name":"Tocantins","total":229764,"year":2016}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/population/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/population/years
{
"result":[
{"year":2016}
]
}Porte do município disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/population/city_size
{
"result":[
{"id":1,"name":"até 5000"},
{"id":2,"name":"5001 - 10000"},
{"id":3,"name":"10001 - 20000"},
{"id":4,"name":"20001 - 50000"},
{"id":5,"name":"50001 - 100000"},
{"id":6,"name":"100001 - 500000"},
{"id":7,"name":"mais que 500000"}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/population/source
{
"result": [
{
"source": "IBGE"
}
]
}Indicador: Matrículas
Para obter as matrículas
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment
{
"result":[
{"total":"53138571","name":"Brasil","year":2007},
{"total":"54253997","name":"Brasil","year":2008},
{"total":"54403671","name":"Brasil","year":2009},
{"total":"53984294","name":"Brasil","year":2010},
{"total":"54286697","name":"Brasil","year":2011},
{"total":"54616055","name":"Brasil","year":2012},
{"total":"55282390","name":"Brasil","year":2013},
{"total":"55924940","name":"Brasil","year":2014},
{"total":"54792495","name":"Brasil","year":2015}
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | /api/v1/enrollment?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/enrollment?dims=adm_dependency_detailed |
|
| education_level | Adiciona ao resultado o campo da etapa educacional com os anos escolares | /api/v1/enrollment?dims=education_level |
|
| education_level_mod | Adiciona ao resultado o campo da etapa educacional | /api/v1/enrollment?dims=education_level_mod |
|
| education_level_short | Adiciona ao resultado o campo da etapa educacional resumida | /api/v1/enrollment?dims=education_level_short |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/enrollment?dims=location |
|
| rural_location | Adiciona ao resultado o campo da localização rural | /api/v1/enrollment?dims=rural_location |
|
| region | Adiciona ao resultado o campo da região | /api/v1/enrollment?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/enrollment?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/enrollment?dims=city |
|
| school | Adiciona ao resultado o campo da escola | /api/v1/enrollment?dims=school |
|
| school_year | Adiciona ao resultado o campo do ano escolar | /api/v1/enrollment?dims=school_year |
|
| gender | Adiciona ao resultado o campo gênero | /api/v1/enrollment?dims=gender |
|
| ethnic_group | Adiciona ao resultado o campo cor/raça | /api/v1/enrollment?dims=ethnic_group |
|
| period | Adiciona ao resultado o campo turno | /api/v1/enrollment?dims=period |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Integer | Filtra o resultado usando o campo da dependência administrativa | /api/v1/enrollment?filter=adm_dependency:1 |
| adm_dependency_detailed | Integer | Filtra o resultado usando o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/enrollment?filter=adm_dependency_detailed:5 |
| education_level | Integer | Filtra o resultado usando o campo da etapa educacional com os anos escolares | /api/v1/enrollment?filter=education_level:8 |
| education_level_mod | Integer | Filtra o resultado usando o campo da etapa educacional | /api/v1/enrollment?filter=education_level_mod:8 |
| education_level_short | Integer | Filtra o resultado usando o campo da etapa educacional resumida | /api/v1/enrollment?filter=education_level_short:8 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/enrollment?filter=location:1 |
| rural_location | Integer | Filtra o resultado usando o campo da localização rural | /api/v1/enrollment?filter=rural_location:1 |
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/enrollment?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/enrollment?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/enrollment?filter=city:4106902 |
| school | Integer | Filtra o resultado usando o campo da escola | /api/v1/enrollment?filter=school:41126882 |
| school_year | Integer | Filtra o resultado usando o campo do ano escolas | /api/v1/enrollment?filter=school_year:11 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/enrollment?filter=min_year:2014 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/enrollment?filter=max_year:2015 |
| gender | Integer | Filtra o resultado usando o campo gênero | /api/v1/enrollment?filter=gender:2 |
| ethnic_group | Integer | Filtra o resultado usando o campo cor/raça | /api/v1/enrollment?filter=ethnic_group |
| period | Integer | Filtra o resultado usando o campo turno | /api/v1/enrollment?filter=period |
{
"result":[
{"state_name":"Paraná","location_name":"Urbana","total":"15894360","name":"Brasil","year":2015},
{"state_name":"Rio Grande do Sul","location_name":"Urbana","total":"14659866","name":"Brasil","year":2015},
{"state_name":"Santa Catarina","location_name":"Urbana","total":"9435684","name":"Brasil","year":2015}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/years
{
"result":[
{
"year":2015
},
{
"year":2016
}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Matrículas)"
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"}
]
}Localizações rurais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"},
{"id":3,"name":"Rural - Área de assentamento"},
{"id":4,"name":"Rural - Terra indígena"},
{"id":5,"name":"Rural - Área remanescente de quilombos"},
{"id":6,"name":"Rural - Unidade de uso sustentável"}
]
}Níveis educacionais com anos escolares disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/education_level
{
"result":[
{"id":1,"name":"Educação Infantil - Creche"},
{"id":2,"name":"Educação Infantil - Pré-escola"},
{"id":3,"name":"Educação Infantil - Unificada"},
{"id":56,"name":"Educação Infantil e Ensino Fundamental (8 e 9 anos) Multietapa"},
{"id":4,"name":"Ensino Fundamental de 8 anos - 1ª Série"},
{"id":5,"name":"Ensino Fundamental de 8 anos - 2ª Série"},
{"id":6,"name":"Ensino Fundamental de 8 anos - 3ª Série"},
{"id":7,"name":"Ensino Fundamental de 8 anos - 4ª Série"},
{"id":8,"name":"Ensino Fundamental de 8 anos - 5ª Série"},
{"id":9,"name":"Ensino Fundamental de 8 anos - 6ª Série"},
{"id":10,"name":"Ensino Fundamental de 8 anos - 7ª Série"},
{"id":11,"name":"Ensino Fundamental de 8 anos - 8ª Série"},
{"id":12,"name":"Ensino Fundamental de 8 anos - Multi"},
{"id":13,"name":"Ensino Fundamental de 8 anos - Correção de Fluxo"},
{"id":14,"name":"Ensino Fundamental de 9 anos - 1º Ano"},
{"id":15,"name":"Ensino Fundamental de 9 anos - 2º Ano"},
{"id":16,"name":"Ensino Fundamental de 9 anos - 3º Ano"},
{"id":17,"name":"Ensino Fundamental de 9 anos - 4º Ano"},
{"id":18,"name":"Ensino Fundamental de 9 anos - 5º Ano"},
{"id":19,"name":"Ensino Fundamental de 9 anos - 6º Ano"},
{"id":20,"name":"Ensino Fundamental de 9 anos - 7º Ano"},
{"id":21,"name":"Ensino Fundamental de 9 anos - 8º Ano"},
{"id":41,"name":"Ensino Fundamental de 9 anos - 9º Ano"},
{"id":22,"name":"Ensino Fundamental de 9 anos - Multi"},
{"id":23,"name":"Ensino Fundamental de 9 anos - Correção de Fluxo"},
{"id":24,"name":"Ensino Fundamental de 8 e 9 anos - Multi 8 e 9 anos"},
{"id":25,"name":"Ensino Médio - 1ª Série"},
{"id":26,"name":"Ensino Médio - 2ª Série"},
{"id":27,"name":"Ensino Médio - 3ª Série"},
{"id":28,"name":"Ensino Médio - 4ª Série"},
{"id":29,"name":"Ensino Médio - Não Seriada 30 - Curso Técnico Integrado (Ensino Médio Integrado) 1ª Série"},
{"id":30,"name":"Curso Técnico Integrado (Ensino Médio Integrado) 1ª Série"},
{"id":31,"name":"Curso Técnico Integrado (Ensino Médio Integrado) 2ª Série"},
{"id":32,"name":"Curso Técnico Integrado (Ensino Médio Integrado) 3ª Série"},
{"id":33,"name":"Curso Técnico Integrado (Ensino Médio Integrado) 4ª Série"},
{"id":34,"name":"Curso Técnico Integrado (Ensino Médio Integrado) Não Seriada"},
{"id":35,"name":"Ensino Médio - Normal/Magistério 1ª Série"},
{"id":36,"name":"Ensino Médio - Normal/Magistério 2ª Série"},
{"id":37,"name":"Ensino Médio - Normal/Magistério 3ª Série"},
{"id":38,"name":"Ensino Médio - Normal/Magistério 4ª Série"},
{"id":39,"name":"Curso Técnico - Concomitante"},
{"id":40,"name":"Curso Técnico - Subsequente"},
{"id":64,"name":"Curso Técnico Misto (Concomitante e Subsequente)"},
{"id":68,"name":"Curso FIC Concomitante"},
{"id":65,"name":"EJA - Ensino Fundamental - Projovem Urbano"},
{"id":67,"name":"Curso FIC integrado na modalidade EJA - Nível Médio"},
{"id":69,"name":"EJA - Ensino Fundamental - Anos Iniciais"},
{"id":70,"name":"EJA - Ensino Fundamental - Anos Finais"},
{"id":71,"name":"EJA - Ensino Médio"},
{"id":72,"name":"EJA - Ensino Fundamental - Anos Iniciais e Anos Finais"},
{"id":73,"name":"Curso FIC integrado na modalidade EJA - Nível Fundamental (EJA integrada à Educação Profissional de Nível Fundamental)"},
{"id":74,"name":"Curso Técnico Integrado na Modalidade EJA (EJA integrada à Educação Profissional de Nível Médio)"}
]
}Níveis educacionais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/education_level_mod
{
"result":[
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-escola"},
{"id":3,"name":"Educação Infantil Unificada"},
{"id":4,"name":"Educação Infantil e Ensino Fundamental - multietapa"},
{"id":5,"name":"Ensino Fundamental - anos iniciais"},
{"id":6,"name":"Ensino Fundamental - anos finais"},
{"id":7,"name":"Ensino Fundamental multietapa e correção de fluxo"},
{"id":8,"name":"Ensino Médio"},
{"id":9,"name":"EJA - Ensino Fundamental"},
{"id":10,"name":"EJA - Ensino Médio"},
{"id":11,"name":"Educação Profissional"},
{"id":99,"name":"não classificado"}
]
}Níveis educacionais resumidos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/education_level_short
{
"result":[
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-escola"},
{"id":3,"name":"Ensino Fundamental - anos iniciais"},
{"id":4,"name":"Ensino Fundamental - anos finais"},
{"id":5,"name":"Ensino Médio"},
{"id":6,"name":"EJA"},
{"id":7,"name":"EE exclusiva"},
{"id":99,"name":"não classificado"}
]
}Anos escolares disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/school_year
{
"result":[
{"id":11,"name":"Creche - menor que 1 ano"},
{"id":12,"name":"Creche - 1 ano"},
{"id":13,"name":"Creche - 2 anos"},
{"id":14,"name":"Creche - 3 anos"},
{"id":21,"name":"Pré-escola - 4 anos"},
{"id":22,"name":"Pré-escola - 5 anos"},
{"id":31,"name":"EF-AI 1 ano e 6 anos"},
{"id":32,"name":"EF-AI 2 ano"},
{"id":33,"name":"EF-AI 3 ano"},
{"id":34,"name":"EF-AI 4 ano"},
{"id":35,"name":"EF-AI 5 ano"},
{"id":41,"name":"EF-AF 6 ano"},
{"id":42,"name":"EF-AF 7 ano"},
{"id":43,"name":"EF-AF 8 ano"},
{"id":44,"name":"EF-AF 9 ano"},
{"id":51,"name":"EM 1 série"},
{"id":52,"name":"EM 2 série"},
{"id":53,"name":"EM 3 série"},
{"id":54,"name":"EM 4 série"},
{"id":61,"name":"EJA AI"},
{"id":62,"name":"EJA AF"},
{"id":63,"name":"EJA EM"},
{"id":64,"name":"EJA semi-presencial"},
{"id":71,"name":"EP"},
{"id":81,"name":"Atividades complementares e AEE"},
{"id":99,"name":"não classificado"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Gêneros disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/gender
{
"result":[
{"id":1,"name":"Masculino"},
{"id":2,"name":"Feminino"}
]
}Grupos étnicos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/ethnic_group
{
"result":[
{"id":0,"name":"Não declarada"},
{"id":1,"name":"Branca"},
{"id":2,"name":"Preta"},
{"id":3,"name":"Parda"},
{"id":4,"name":"Amarela"},
{"id":5,"name":"Indígena"}
]
}Turnos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/period
{
"result":[
{"id":1,"name":"Diurno"},
{"id":2,"name":"Noturno"},
{"id":3,"name":"Integral"},
{"id":99,"name":"Indefinido"}
]
}Indicador: Turmas
Para obter as turmas
GET https://simcaq.c3sl.ufpr.br/api/v1/class
{
"result":[
{"total":"2164640","name":"Brasil","year":2015}
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| education_level_mod | Adiciona ao resultado o campo da etapa de ensino | /api/v1/class?dims=education_level_mod |
|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | /api/v1/class?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/class?dims=adm_dependency_detailed |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/class?dims=location |
|
| region | Adiciona ao resultado o campo da região | /api/v1/class?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/class?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/class?dims=city |
|
| school | Adiciona ao resultado o campo da escola | /api/v1/class?dims=school |
|
| period | Adiciona ao resultado o campo turno | /api/v1/class?dims=period |
|
| integral_time | Adiciona ao resultado o campo tempo integral | /api/v1/class?dims=integral_time |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Integer | Filtra o resultado usando o campo da dependência administrativa | /api/v1/class?filter=adm_dependency:1 |
| adm_dependency_detailed | Integer | Filtra o resultado usando o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/class?filter=adm_dependency_detailed:5 |
| education_level_mod | Integer | Filtra o resultado usando o campo da etapa de ensino | /api/v1/class?filter=education_level:8 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/class?filter=location:1 |
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/class?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/class?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/class?filter=city:4106902 |
| school | Integer | Filtra o resultado usando o campo da escola | /api/v1/class?filter=school:41126882 |
| period | Integer | Filtra o resultado usando o campo turno | /api/v1/class?filter=period |
| integral_time | boolean | Filta o resultado o campo tempo integral | /api/v1/class?filter=integral_time:false |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/class?filter=min_year:2014 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/class?filter=max_year:2015 |
GET https://simcaq.c3sl.ufpr.br/api/v1/class?dims=state,location&filter=min_year:2015,region:4,location:1
{
"result":[
{"state_name":"Paraná","total":107715,"name":"Brasil","year":2015,"location_name":"Urbana"},
{"state_name":"Rio Grande do Sul","total":106412,"name":"Brasil","year":2015,"location_name":"Urbana"},
{"state_name":"Santa Catarina","total":67197,"name":"Brasil","year":2015,"location_name":"Urbana"}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/years
{
"result":[
{
"year": 2015
},
{
"year": 2016
}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Turmas)"
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"},
{"id":3,"name":"Área de assentamento"},
{"id":4,"name":"Terra indígena"},
{"id":5,"name":"Área remanescente de quilombos"},
{"id":6,"name":"Unidade de uso sustentável"}
]
}Níveis educacionais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/education_level_mod
{
"result":[
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-escola"},
{"id":3,"name":"Educação Infantil Unificada"},
{"id":4,"name":"Educação Infantil e Ensino Fundamental - multietapa"},
{"id":5,"name":"Ensino Fundamental - anos iniciais"},
{"id":6,"name":"Ensino Fundamental - anos finais"},
{"id":7,"name":"Ensino Fundamental multietapa e correção de fluxo"},
{"id":8,"name":"Ensino Médio"},
{"id":9,"name":"EJA - Ensino Fundamental"},
{"id":10,"name":"EJA - Ensino Médio"},
{"id":11,"name":"Educação Profissional"},
{"id":99,"name":"não classificado"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/enrollment/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Turnos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/period
{
"result":[
{"id":1,"name":"Diurno"},
{"id":2,"name":"Noturno"},
{"id":3,"name":"Integral"},
{"id":99,"name":"Indefinido"}
]
}Tempo integral disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/class/integral_time
{
"result":[
{"id":null,"name":"Não Disponível"},
{"id":0,"name":"Não"},
{"id":1,"name":"Sim"}
]
}Indicador: Contagem do Número de Salas
Para acessar a rota e obter o número de salas de aula
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom
{
"result":[
{"total":"1460609","name":"Brasil","year":2015}
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | api/v1/classroom?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/classroom?dims=adm_dependency_detailed |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/classroom?dims=location |
|
| region | Adiciona ao resultado o campo da região | /api/v1/classroom?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/classroom?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/classroom?dims=city |
|
| school | Adiciona ao resultado o campo da escola | /api/v1/classroom?dims=school |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Integer | Filtra o resultado usando o campo da dependência administrativa | /api/v1/classroom?filter=adm_dependency:1 |
| adm_dependency_detailed | Integer | Filtra o resultado usando o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/classroom?filter=adm_dependency_detailed:5 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/classroom?filter=location:1 |
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/classroom?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/classroom?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/classroom?filter=city:4106902 |
| school | Integer | Filtra o resultado usando o campo da escola | /api/v1/classroom?filter=school:41126882 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/classroom?filter=min_year:2014 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/classroom?filter=max_year:2015 |
https://simcaq.c3sl.ufpr.br/api/v1/classroom?dims=state,location&filter=min_year:2015region:4
{
"result":[
{"state_name":"Paraná","total":"84652","name":"Brasil","year":2015,"location_name":"Urbana"},
{"state_name":"Paraná","total":"8202","name":"Brasil","year":2015,"location_name":"Rural"},
{"state_name":"Rio Grande do Sul","total":"77694","name":"Brasil","year":2015,"location_name":"Urbana"},
{"state_name":"Rio Grande do Sul","total":"10980","name":"Brasil","year":2015,"location_name":"Rural"},
{"state_name":"Santa Catarina","total":"51925","name":"Brasil","year":2015,"location_name":"Urbana"},
{"state_name":"Santa Catarina","total":"5177","name":"Brasil","year":2015,"location_name":"Rural"}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom/year_range
{
"result":[
{
"start_year":2015,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom/years
{
"result":[
{
"year": 2015
},
{
"year": 2016
}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Escolas)"
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom/location
{
"result":[
{"id":1,"name": "Urbana"},
{"id":2,"name": "Rural"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/classroom/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Indicador: Número de Escolas
Obter todas as escolas
Para obter o total de escolas no Brasil
GET https://simcaq.c3sl.ufpr.br/api/v1/school/count
{
"result":[
{"total":181243,"name":"Brasil","year":2015},
{"total":181205,"name":"Brasil","year":2016}
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| location | Adiciona ao resultado o campo de Área da Localidade | /api/v1/school/count?dims=location |
|
| adm_dependency | Adiciona ao resultado o campo de Dependência Administrativa | /api/v1/school/count?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo de Dependência Administrativa com detalhamento das escolas privadas | /api/v1/school/count?dims=adm_dependency_detailed |
|
| government_agreement | Adiciona ao resultado o campo de Conveniada com o poder público | /api/v1/school/count?dims=government_agreement |
|
| agreement | Adiciona ao resultado o campo de Dependência do convênio com o poder público | /api/v1/school/count?dims=agreement |
|
| education_day_care_child | Adiciona ao resultado o campo de Escola oferece Creche em classes comuns do ensino regular | /api/v1/school/count?dims=education_day_care_child |
|
| education_preschool_child | Adiciona ao resultado o campo de Escola oferece Pré-escola em classes comuns do ensino regular | /api/v1/school/count?dims=education_preschool_child |
|
| education_begin_elementary_school | Adiciona ao resultado o campo de Escola oferece Anos Iniciais do Ensino Fundamental | /api/v1/school/count?dims=education_begin_elementary_school |
|
| education_end_elementary_school | Adiciona ao resultado o campo de Escola oferece Anos Finais do Ensino Fundamental | /api/v1/school/count?dims=education_end_elementary_school |
|
| education_middle_school | Adiciona ao resultado o campo de Escola oferece Ensino Médio | /api/v1/school/count?dims=education_middle_school |
|
| education_professional | Adiciona ao resultado o campo de Educação Profissional | /api/v1/school/count?dims=education_professional |
|
| education_eja | Adiciona ao resultado o campo de ensino EJA | /api/v1/school/count?dims=education_eja |
Filtros
Para filtrar o total de escolas no Brasil de acordo com determinado campo.
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/school/count?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/school/count?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/school/count?filter=city:4106902 |
| year | Integer | Filtra o resultado com o número de escolas do ano | /api/v1/school/count?filter=year:2016 |
| max_year | Integer | Filtra o resultado com o número de escolas até ano | /api/v1/school/count?filter=max_year:2016 |
| min_year | Integer | Filtra o resultado com o número de escolas do ano e após o ano | /api/v1/school/count?filter=min_year:2016 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/school/count?filter=location:1 |
| adm_dependency | Integer | Filtra o resultado com o campo de Dependência Administrativa | /api/v1/school/count?filter=adm_dependency:3 |
| adm_dependency_detailed | Integer | Filtra o resultado usando o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/school/count?filter=adm_dependency_detailed:5 |
| government_agreement | Boolean | Filtra o resultado com o número de escolas Conveniada com o poder público | /api/v1/school/count?filter=government_agreement:1 |
| agreement | Integer | Filtra o resultado com o número de escolas que possui convênio com o poder público | /api/v1/school/count?filter=agreement:2 |
| education_day_care_child | Boolean | Filtra o resultado com o número de escolas que oferece Creche em classes comuns do ensino regular | /api/v1/school/count?filter=education_day_care_child:1 |
| education_preschool_child | Boolean | Filtra o resultado com o número de escolas que oferece Pré-escola em classes comuns do ensino regular | /api/v1/school/count?filter=education_preschool_child:1 |
| education_begin_elementary_school | Boolean | Filtra o resultado com o número de escolas que oferece Anos Iniciais do Ensino Fundamental (8 e 9 anos) em classes comuns do ensino regular | /api/v1/school/count?filter=education_begin_elementary_school:1 |
| education_end_elementary_school | Boolean | Filtra o resultado com o número de escolas que oferece Anos Finais do Ensino Fundamental (8 e 9 anos) em classes comuns do ensino regular | /api/v1/school/count?filter=education_end_elementary_school:1 |
| education_middle_school | Boolean | Filtra o resultado com o número de escolas que oferece Ensino Médio - Médio Propedêutico em classes comuns do ensino regular | /api/v1/school/count?filter=education_middle_school:1 |
| education_professional | Boolean | Filtra o resultado com o número de escolas que possui educacao profissional | /api/v1/school/count?filter=education_professional:1 |
| education_eja | Boolean | Filtra o resultado com o número de escolas que possui ensino EJA | /api/v1/school/count?filter=education_eja:1 |
GET https://simcaq.c3sl.ufpr.br/api/v1//school/count?filter=adm_dependency:3
{
"result":[
{"total":114914,"name":"Brasil","year":2015},
{"total":114016,"name":"Brasil","year":2016}
]
}Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/year_range
{
"result":[
{
"start_year":2015,
"end_year":2016
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/years
{
"result":[
{
"year": 2015
},
{
"year": 2016
}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Escolas)"
}
]
}Valores possíveis dos campos booleanos para este indicador
A maioria dos campos deste indicar são booleanos e seus valores assumem o padrão a seguir:
GET https://simcaq.c3sl.ufpr.br/api/v1/school/science_lab
{
"result":[
{"id":null,"name":"Não Declarado"},
{"id":0,"name":"Não"},
{"id":1,"name":"Sim"}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Dependência do convênio com o poder públicos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/school/agreement
{
"result":[
{"id":1,"name":"Estadual"},
{"id":2,"name":"Municipal"},
{"id":3,"name":"Estadual e Municipal"}
]
}Valores possíveis dos campos booleanos para este indicador
Os outros campos deste indicar são booleanos e seus valores assumem o padrão a seguir:
GET https://simcaq.c3sl.ufpr.br/api/v1/school/education_eja
{
"result":[
{"id":null,"name":"Não Declarado"},
{"id":0,"name":"Não"},
{"id":1,"name":"Sim"}
]
}Indicador: Professores
Para obter a contagem de professores
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher
Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | /api/v1/teacher?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/teacher?dims=adm_dependency_detailed |
|
| education_level_mod | Adiciona ao resultado o campo da etapa educacional | /api/v1/teacher?dims=education_level_mod |
|
| education_level_short | Adiciona ao resultado o campo da etapa educacional resumida | /api/v1/teacher?dims=education_level_short |
|
| education_type | Adiciona ao resultado o campo do nível de formação | /api/v1/teacher?dims=education_type |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/teacher?dims=location |
|
| rural_location | Adiciona ao resultado o campo da localização rural | /api/v1/teacher?dims=rural_location |
|
| region | Adiciona ao resultado o campo da região | /api/v1/teacher?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/teacher?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/teacher?dims=city |
|
| school | Adiciona ao resultado o campo da escola | /api/v1/teacher?dims=school |
|
| gender | Adiciona ao resultado o campo gênero | /api/v1/teacher?dims=gender |
|
| contract_type | Adiciona ao resultado o campo tipo de contratação | /api/v1/teacher?dims=contract_type |
|
| ethnic_group | Adiciona ao resultado o campo cor/raça | /api/v1/teacher?dims=ethnic_group |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Integer | Filtra o resultado usando o campo da dependência administrativa | /api/v1/teacher?filter=adm_dependency:1 |
| adm_dependency_detailed | Integer | Filtra o resultado usando o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/teacher?filter=adm_dependency_detailed:5 |
| education_level_mod | Integer | Filtra o resultado usando o campo da etapa educacional | /api/v1/teacher?filter=education_level_mod:8 |
| education_level_short | Integer | Filtra o resultado usando o campo da etapa educacional resumida | /api/v1/teacher?filter=education_level_short:8 |
| education_type | Filtra o resultado usando o campo do nível de formação | /api/v1/teacher?filter=education_type:1 |
|
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/teacher?filter=location:1 |
| rural_location | Integer | Filtra o resultado usando o campo da localização rural | /api/v1/teacher?filter=rural_location:1 |
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/teacher?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/teacher?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/teacher?filter=city:4106902 |
| school | Integer | Filtra o resultado usando o campo da escola | /api/v1/teacher?filter=school:41126882 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/teacher?filter=min_year:2014 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/teacher?filter=max_year:2015 |
| gender | Integer | Filtra o resultado usando o campo gênero | /api/v1/teacher?filter=gender:2 |
| contract_type | Integer | Filtra o resultado usando o campo tipo de contratação | /api/v1/teacher?filter=contract_type:2 |
| ethnic_group | Integer | Filtra o resultado usando o campo cor/raça | /api/v1/teacher?filter=ethnic_group |
Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/year_range
{
"result":[
{
"start_year":2007,
"end_year":2015
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/years
{
"result":[
{
"year": 2015
},
{
"year": 2016
}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Docentes)"
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"}
]
}Localizações rurais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"},
{"id":3,"name":"Rural - Área de assentamento"},
{"id":4,"name":"Rural - Terra indígena"},
{"id":5,"name":"Rural - Área remanescente de quilombos"},
{"id":6,"name":"Rural - Unidade de uso sustentável"}
]
}Níveis educacionais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/education_level_mod
{
"result":[
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-escola"},
{"id":3,"name":"Educação Infantil Unificada"},
{"id":4,"name":"Educação Infantil e Ensino Fundamental - multietapa"},
{"id":5,"name":"Ensino Fundamental - anos iniciais"},
{"id":6,"name":"Ensino Fundamental - anos finais"},
{"id":7,"name":"Ensino Fundamental multietapa e correção de fluxo"},
{"id":8,"name":"Ensino Médio"},
{"id":9,"name":"EJA - Ensino Fundamental"},
{"id":10,"name":"EJA - Ensino Médio"},
{"id":11,"name":"Educação Profissional"},
{"id":99,"name":"não classificado"}
]
}Níveis educacionais resumidos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/education_level_short
{
"result":[
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-escola"},
{"id":3,"name":"Ensino Fundamental - anos iniciais"},
{"id":4,"name":"Ensino Fundamental - anos finais"},
{"id":5,"name":"Ensino Médio"},
{"id":6,"name":"EJA"},
{"id":7,"name":"EE exclusiva"},
{"id":99,"name":"não classificado"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Gêneros disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/gender
{
"result":[
{"id":1,"name":"Masculino"},
{"id":2,"name":"Feminino"}
]
}Tipos de contratação disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/contract_type
{
"result":[
{"id":1,"name":"Concursado/Efetivo/Estável"},
{"id":2,"name":"Contrato temporário"},
{"id":3,"name":"Contrato terceirizado"},
{"id":4,"name":"Contrato CLT"}
]
}Grupos étnicos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/teacher/ethnic_group
{
"result":[
{"id":0,"name":"Não declarada"},
{"id":1,"name":"Branca"},
{"id":2,"name":"Preta"},
{"id":3,"name":"Parda"},
{"id":4,"name":"Amarela"},
{"id":5,"name":"Indígena"}
]
}Indicador: Infraestrutura
Obter infraestrutura
GET https://simcaq.c3sl.ufpr.br/api/v1/infrastrcutre
- total: número total de escolas
- partial: número total de escolas que atendem a condição
- percentage: percentual de escolas que atendem a condição
{
"result": [
{
"school_place": [
{
"total": 192678,
"name": "Brasil",
"year": 2013,
"percentage": 28.1957462709806,
"partial": 54327
}
],
"libraries": [
{
"total": 96956,
"name": "Brasil",
"year": 2013,
"percentage": 48.45703205577788,
"partial": 46982
}
],
"libraries_reading_room": [
{
"total": 61192,
"name": "Brasil",
"year": 2013,
"percentage": 7.254216237416655,
"partial": 4439
}
],
"computer_lab": [
{
"total": 48806,
"name": "Brasil",
"year": 2013,
"percentage": 73.09552104249477,
"partial": 35675
}
],
"science_lab": [
{
"total": 48806,
"name": "Brasil",
"year": 2013,
"percentage": 28.248575994754745,
"partial": 13787
}
],
...
}]
}Parâmetros
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/infrastructure?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/infrastructure?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/infrastructure?dims=city |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/infrastructure?dims=location |
|
| rural_location | Adiciona ao resultado o campo da localização rural | /api/v1/infrastructure?dims=rural_location |
|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | /api/v1/infrastructure?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa detalhada | /api/v1/infrastructure?dims=adm_dependency_detailed |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/infrastructure?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/infrastructure?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/infrastructure?filter=city:4106902 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/infrastructure?filter=location:1 |
| rural_location | Integer | Filtra o resultado usando o campo da localização rural | /api/v1/infrastructure?filter=rural_location:1 |
| adm_dependency | Filtra o resultado usando o campo da dependência administrativa | /api/v1/infrastructure?filter=adm_dependency:1 |
|
| adm_dependency_detailed | Filtra o resultado usando o campo da dependência administrativa detalhada | /api/v1/infrastructure?filter=adm_dependency_detailed:1 |
|
| min_year | Filtra o resultado usando o campo do ano mínimo | /api/v1/infrastructure?filter=min_year:2015 |
|
| max_year | Filtra o resultado usando o campo do ano máximo | /api/v1/infrastructure?filter=max_year:2013 |
Indicador: Número de Auxiliares Docentes
Para obter a contagem de auxiliares docentes
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/count
Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | /api/v1/auxiliar/count?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/auxiliar/count?dims=adm_dependency_detailed |
|
| education_level_mod | Adiciona ao resultado o campo da etapa educacional | /api/v1/auxiliar/count?dims=education_level_mod |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/auxiliar/count?dims=location |
|
| rural_location | Adiciona ao resultado o campo da localização rural | /api/v1/auxiliar/count?dims=rural_location |
|
| region | Adiciona ao resultado o campo da região | /api/v1/auxiliar/count?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/auxiliar/count?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/auxiliar/count?dims=city |
|
| school | Adiciona ao resultado o campo da escola | /api/v1/auxiliar/count?dims=school |
|
| gender | Adiciona ao resultado o campo gênero | /api/v1/auxiliar/count?dims=gender |
|
| ethnic_group | Adiciona ao resultado o campo cor/raça | /api/v1/auxiliar/count?dims=ethnic_group |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| adm_dependency | Integer | Filtra o resultado usando o campo da dependência administrativa | /api/v1/auxiliar/count?filter=adm_dependency:1 |
| adm_dependency_detailed | Integer | Filtra o resultado usando o campo da dependência administrativa com detalhamento das escolas privadas | /api/v1/auxiliar/count?filter=adm_dependency_detailed:5 |
| education_level_mod | Integer | Filtra o resultado usando o campo da etapa educacional | /api/v1/auxiliar/count?filter=education_level_mod:8 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/auxiliar/count?filter=location:1 |
| rural_location | Integer | Filtra o resultado usando o campo da localização rural | /api/v1/auxiliar/count?filter=rural_location:1 |
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/auxiliar/count?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/auxiliar/count?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/auxiliar/count?filter=city:4106902 |
| school | Integer | Filtra o resultado usando o campo da escola | /api/v1/auxiliar/count?filter=school:33141177 |
| min_year | Integer | Filtra o resultado usando como ano mínimo o ano especificado | /api/v1/auxiliar/count?filter=min_year:2014 |
| max_year | Integer | Filtra o resultado usando como ano máximo o ano especificado | /api/v1/auxiliar/count?filter=max_year:2015 |
| gender | Integer | Filtra o resultado usando o campo gênero | /api/v1/auxiliar/count?filter=gender:2 |
| ethnic_group | Integer | Filtra o resultado usando o campo cor/raça | /api/v1/auxiliar/count?filter=ethnic_group:1 |
Intervalo de anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/year_range
{
"result":[
{
"start_year":2013,
"end_year":2017
}
]
}Anos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/years
{
"result":[
{"year":2013},
{"year":2014},
{"year":2015},
{"year":2016},
{"year":2017}
]
}Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Docentes)"
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"}
]
}Localizações rurais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/rural_location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"},
{"id":3,"name":"Rural - Área de assentamento"},
{"id":4,"name":"Rural - Terra indígena"},
{"id":5,"name":"Rural - Área remanescente de quilombos"},
{"id":6,"name":"Rural - Unidade de uso sustentável"}
]
}Níveis educacionais disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/education_level_mod
{
"result":[
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-escola"},
{"id":3,"name":"Educação Infantil Unificada"},
{"id":4,"name":"Educação Infantil e Ensino Fundamental - multietapa"},
{"id":5,"name":"Ensino Fundamental - anos iniciais"},
{"id":6,"name":"Ensino Fundamental - anos finais"},
{"id":7,"name":"Ensino Fundamental multietapa e correção de fluxo"},
{"id":8,"name":"Ensino Médio"},
{"id":9,"name":"EJA - Ensino Fundamental"},
{"id":10,"name":"EJA - Ensino Médio"},
{"id":11,"name":"Educação Profissional"},
{"id":99,"name":"não classificado"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Gêneros disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/gender
{
"result":[
{"id":1,"name":"Masculino"},
{"id":2,"name":"Feminino"}
]
}Grupos étnicos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/auxiliar/ethnic_group
{
"result":[
{"id":0,"name":"Não declarada"},
{"id":1,"name":"Branca"},
{"id":2,"name":"Preta"},
{"id":3,"name":"Parda"},
{"id":4,"name":"Amarela"},
{"id":5,"name":"Indígena"}
]
}Fatores de distribuição de matrícula
Essa rota retorna os fatores de distribuição de matrícula
GET https://simcaq.c3sl.ufpr.br/api/v1/distribution_factor
{
"result": [
{
"city_id": 1100015,
"series":[
{
"serie_id": 11,
"distribution_factor_addition": 0.0001258,
"distribution_factor_reduction": 0
},
...
]
},
...
]
}Dimensões
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/distribution_factor?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/distribution_factor?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/distribution_factor?dims=city |
Filtros
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/distribution_factor?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/distribution_factor?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/distribution_factor?filter=city:4106902 |
Indicador: Taxa de Carga Horária Diária
Requisitos SIMCAQ
Para esse indicador funcionar corretamente é necessário os campos tempo integral e/ou período como dimensão ou como filtro.
Requisitos LDE
Para esse indicador funcionar corretamente é necessário os campos etapas e modalidades por segmento, tempo integral e/ou período como dimensão ou como filtro.
Obter carga horária diária
SIMCAQ
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount?filter=education_level_short:["4","5"],integral_time:"0",period:["3"]
LDE
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/average?filter=education_level_mod:["4","5"],integral_time:"0",period:["3"],min_year:"2013",max_year:"2013"
{
"result":
{
"year": 2013,
"education_level_short_id": 4,
"total": 3.7211387,
"education_level_short_name": "Ensino Fundamental - anos finais"
}
}Parâmetros Gerais
Obrigatórios
filter
| Parâmetro | Tipo | Descrição | Exemplo de URL |
|---|---|---|---|
| integral_time | integer | Filtra o resultado usando o campo tempo integral | /api/v1/daily_charge_amount?filter=integral_time:"1" |
| period | integer | Filtra o resultado usando o turno de turma | /api/v1/daily_charge_amount?filter=integral_time:"0",period:["3"] |
Opcionais
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Adiciona ao resultado o campo da região | /api/v1/daily_charge_amount?dims=region&filter=integral_time:"1" |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/daily_charge_amount?dims=state&filter=integral_time:"1" |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/daily_charge_amount?dims=location&filter=integral_time:"1" |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/daily_charge_amount?filter=region:2,integral_time:"1" |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/daily_charge_amount?filter=state:41,integral_time:"1" |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/daily_charge_amount?filter=location:1,integral_time:"1" |
| min_year | Integer | Filtra o resultado usando o campo do ano mínimo | /api/v1/daily_charge_amount?filter=min_year:2015,integral_time:"1" |
| max_year | Integer | Filtra o resultado usando o campo do ano máximo | /api/v1/daily_charge_amount?filter=max_year:2013,integral_time:"1" |
Parâmetros Específicos
SIMCAQ
| Parâmetro | Tipo | Descrição | Exemplo de URL |
|---|---|---|---|
| education_level_short | integer | Filtra o resultado usando o campo de etapa resumida | /api/v1/daily_charge_amount?filter=education_level_short:["4","5"],integral_time:"0",period:["3"] |
LDE (Obrigatório)
| Parâmetro | Tipo | Descrição | Exemplo de URL |
|---|---|---|---|
| education_level_mod | integer | Filtra o resultado usando o campo de etapa e modalidade por segmento | /api/v1/daily_charge_amount/average?filter=education_level_mod:["5","6"],integral_time:"0",period:["3"] |
Turnos possíveis
| Tempo Integral | Turno de Turma | Descrição |
|---|---|---|
| 0 | 1,2 | Diurno parcial |
| 1 | Integral | |
| 0 | 3 | Noturno |
Fonte do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/source
{
"result":[
{
"source":"Microdados do Censo Escolar/INEP (arquivo Turmas)"
}
]
}Anos disponíveis do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/years
{
"result":[
{
"year":2013
},
{
"year":2014
},
{
"year":2015
},
{
"year":2016
},
{
"year":2017
}
]
}Localizações disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/location
{
"result":[
{
"id":1,
"name":"Urbana"
},
{
"id":2,
"name":"Rural"
}
]
}Períodos disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/period
{
"result":[
{
"id":1,
"name":"Matutino"
},
{
"id":2,
"name":"Vespertino"
},
{
"id":3,
"name":"Noturno"
},
{
"id":99,
"name":"Indefinido"
}
]
}Tempo integral disponível para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/integral_time
{
"result":[
{
"id":null,
"name":"Não Disponível"
},
{
"id":0,
"name":"Não"
},
{
"id":1,
"name":"Sim"
}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/adm_dependency
{
"result":[
{
"id":1,
"name":"Federal"
},
{
"id":2,
"name":"Estadual"
},
{
"id":3,
"name":"Municipal"
},
{
"id":4,
"name":"Privada"
}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/adm_dependency_detailed
{
"result":[
{
"id":1,
"name":"Federal"
},
{
"id":2,
"name":"Estadual"
},
{
"id":3,
"name":"Municipal"
},
{
"id":4,
"name":"Privada conveniada"
},
{
"id":5,
"name":"Privada não conveniada sem fins lucrativos"
},
{
"id":6,
"name":"Privada não conveniada com fins lucrativos"
},
]
}Etapa de educação disponíveis para o indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/education_level_short
{
"result":[
{
"id":null,
"name":"Não classificada"
},
{
"id":1,
"name":"Creche"
},
{
"id":2,
"name":"Pré-Escola"
},
{
"id":3,
"name":"Ensino Fundamental - anos iniciais"
},
{
"id":4,
"name":"Ensino Fundamental - anos finais"
},
{
"id":5,
"name":"Ensino Médio"
},
{
"id":6,
"name":"EJA"
},
{
"id":7,
"name":"EE exclusiva"
}
]
}Etapa de educação disponíveis para o indicador [LDE]
GET https://simcaq.c3sl.ufpr.br/api/v1/daily_charge_amount/average/education_level_mod
{
"result":[
{
"id":null,
"name":"Não classificada"
},
{
"id":1,
"name":"Creche"
},
{
"id":2,
"name":"Pré-Escola"
},
{
"id":3,
"name":"Educação Infantil Unificada"
},
{
"id":4,
"name":"Ensino Fundamental - anos iniciais"
},
{
"id":5,
"name":"Ensino Fundamental - anos finais"
},
{
"id":6,
"name":"Ensino Médio"
},
{
"id":7,
"name":"Turma Multisseriadas e Multietapas"
},
{
"id":8,
"name":"EJA - Ensino Fundamental"
},
{
"id":9,
"name":"EJA - Ensino Médio"
},
{
"id":10,
"name":"Educação Profissional"
}
]
}Simulação
O modelo da simulação possui os seguintes campos:
- userId: id do usuário dono da simulação
- content: campo texto com o conteúdo da simulação
- name: campo texto com o nome da simulação
- createdAt: data da criação do modelo (gerada automaticamente)
- updatedtAt: dada da última modficação do modelo (gerada automaticamente)
A simulação padrão (PQR) contém apenas o campo content
Para obter o tempo máximo das simulações
GET https://simcaq.c3sl.ufpr.br/api/v1/simulation/time
Simulação padrão (PQR)
Para obter a simulação padrão:
GET https://simcaq.c3sl.ufpr.br/api/v1/simulation/pqr
Para alterar a simulação padrão:
PUT https://simcaq.c3sl.ufpr.br/api/v1/simulation/pqr
Simulação do usuário
Obter as simulações do usuário
GET https://simcaq.c3sl.ufpr.br/api/v1/simulation
Não retorna o campo content
Criar uma nova simulação para o usuário
POST https://simcaq.c3sl.ufpr.br/api/v1/simulation
Junto da requisição, deve ser enviado um objeto JSON com o campo content.
Obter uma simulação s do usuário
GET https://simcaq.c3sl.ufpr.br/api/v1/simulation/:id
Substitua :id pelo id da simulação desejada. Retorna todos os campos da simulação
Alterar uma simulação do usuário
PUT https://simcaq.c3sl.ufpr.br/api/v1/simulation/:id
Substitua :id pelo id da simulação desejada
Deletar uma simulação do usuário
DELETE https://simcaq.c3sl.ufpr.br/api/v1/simulation/:id
Substitua :id pelo id da simulação desejada
Usuário
Cadastrar um novo usuário
POST https://simcaq.c3sl.ufpr.br/api/v1/user
Os dados da requisição devem ser enviados em um objeto com os seguintes campos:
| Campo | Valor | Obrigatório | Descrição |
|---|---|---|---|
| name | String | true | Nome do usuário. |
| String | true | Email do usuário. | |
| password | String | true | Senha do usuário. |
| cpf | String | true | CPF do usuário. |
| nickname | String | true | Apelido do usuário no sistema. |
| schooling | String | true | Nível de escolaridade do usuário. |
| course | String | false | Curso ou área de atuação do usuário. |
| segment | String | true | Segmento da sociedade em que o usuário atua. |
| citesegment | String | false | Segmento da sociedade em que o usuário atua, caso ele selecione 'Outros'. |
| role | String | true | Função desempenhada pelo usuário. |
| citerole | String | false | Função desempenhada pelo usuário, caso ele selecione outros |
| institution_name | String | true | Nome da instituição onde o usuário atua. |
| state | String | true | Estado do usuário. |
| city | String | true | Cidade do usuário. |
| receive_emails | Boolean | false | Campo para indicar se o usuário deseja ou não receber emails do sistema. |
| cep | String | true | CEP do usuário. |
| complement | String | false | Complemento do endereço. |
| address | String | false | Endereço do usuário. |
| phone | String | false | Telefone do usuário. |
| origin | String | true | Origem do cadastro. Valores possíveis: 'LDE' ou 'SimCAQ'. |
Em caso de sucesso.
{
"result":
{
"msg": "Usuário {email do usuário} foi criado."
},
}Caso algo tenha dado errado.
{
"result":
{
"err": {}//objeto de erro
"errors": ["Mensagem de erro"] // Mesagens de erro para o frontend
},
}Atualizar um usuário
PUT https://simcaq.c3sl.ufpr.br/api/v1/user/:id
Os dados da requisição devem ser enviados em um objeto com os seguintes campos:
| Campo | Valor | Obrigatório | Descrição |
|---|---|---|---|
| name | String | true | Nome do usuário. |
| String | true | Email do usuário. | |
| cpf | String | true | CPF do usuário. |
| nickname | String | true | Apelido do usuário no sistema. |
| schooling | String | true | Nível de escolaridade do usuário. |
| course | String | false | Curso ou área de atuação do usuário. |
| segment | String | true | Segmento da sociedade em que o usuário atua. |
| citesegment | String | false | Segmento da sociedade em que o usuário atua, caso ele selecione 'Outros'. |
| role | String | true | Função desempenhada pelo usuário. |
| citerole | String | false | Função desempenhada pelo usuário, caso ele selecione outros |
| institution_name | String | true | Nome da instituição onde o usuário atua. |
| state | String | true | Estado do usuário. |
| city | String | true | Cidade do usuário. |
| receive_emails | Boolean | false | Campo para indicar se o usuário deseja ou não receber emails do sistema. |
| cep | String | true | CEP do usuário. |
| complement | String | false | Complemento do endereço. |
| address | String | false | Endereço do usuário. |
| phone | String | false | Telefone do usuário. |
Informações do usuário logado
GET https://simcaq.c3sl.ufpr.br/api/v1/user/me
Esta rota retorna todos os dados do usuário (com exceção da hash da senha)
Autenticar um usuário
A autenticação é feita através de OAuth2.
POST https://simcaq.c3sl.ufpr.br/api/v1/auth/token
Os dados da requisição devem ser enviados como x-www-form-urlencoded com os seguintes campos:
| Campo | Valor | Descrição |
|---|---|---|
| username | String | Email do usuário |
| password | String | Senha do usuário |
| grant_type | String | Valor: 'password' |
| client_secret | String | Segredo do cliente |
| client_id | String | Id do cliente |
Em caso de sucesso a API retorna um token que deve ser adicionado no cabeçalho das requisições.
O access_token deve ser utilizado no cabeçalho 'Authorization' para todas as rotas que necessitem de autenticação do usuário
{
"access_token": "08206d105b57c8ca049a215b0145cdfb27f743e5743d51e399afe305206d42d6",
"refresh_token": "a8f4d6b3f67161c9f8b65b53deeb05f307b78f0269ccfcf3bf4bc1396602faed",
"expires_in": 3600,
"token_type": "Bearer"
}Caso algo tenha dado errado ou o usuário não esteja cadastrado.
{
"error": "invalid_grant",
"error_description": "Invalid resource owner credentials"
}Dados Financeiros - SIOPE
Essa rota retorna os dados financeiros - SIOPE
GET https://simcaq.c3sl.ufpr.br/api/v1/siope
{
"result": [
{
"year":2016,
"state_id":41,
"city_id":4128807,
"fundeb":2268958.58,
"impostos":14413226.59,
"MDE":3603306.6475
},
...
]
}Filtros
filter
Retorna os dados de todas as cidades do estado inclusive os dados do próprio estado.
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/siope?filter=state:41 |
GET https://simcaq.c3sl.ufpr.br/api/v1/siope?filter=state:41
{
"result": [
{
"year":2016,
"state_id":41,
"city_id":4100202,
"fundeb":2261575.76,
"impostos":20963229.86,
"MDE":5240807465,
"state_name":"Paraná",
"state_abbreviation":"PR"
},
...
]
}CUB
Preço do CUB para o SIMCAQ.
SIMCAQ
GET https://simcaq.c3sl.ufpr.br/api/v1/cub/
{
"result":
{
"cod_uf": 12,
"sigla_uf": "AC",
"tipo_preco": "CUB R1",
"preco": 2083.95
},
{
"cod_uf": 27,
"sigla_uf": "AL",
"tipo_preco": "CUB R1",
"preco": 1878.9
}
}Parâmetros Gerais
filter
| Parâmetro | Tipo | Descrição | Exemplo de URL |
|---|---|---|---|
| state | integer | Filtra o resultado usando o campo de estado por código da uf | /api/v1/cub?filter=state:"12" |
| min_year | integer | Filtra o resultado usando o ano mínimo | /api/v1/cub?filter=min_year:"2017" |
| max_year | integer | Filtra o resultado usando o ano máximo | /api/v1/cub?filter=max_year:"2017" |
| min_month | integer | Filtra o resultado usando o mês mínimo | /api/v1/cub?filter=min_month:"8" |
| max_month | integer | Filtra o resultado usando o mês máximo | /api/v1/cub?filter=max_month:"9" |
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| min_year | integer | Adiciona ao resultado o ano | /api/v1/cub?dims=min_year |
| max_year | integer | Adiciona ao resultado o ano | /api/v1/cub?dims=max_year |
| min_month | integer | Adiciona ao resultado o mês | /api/v1/cub?dims=min_month |
| max_month | integer | Adiciona ao resultado o mês | /api/v1/cub?dims=max_month |
Observação
O resultado da média de cada mês do Brasil é obtido quando existe pelo menos um filtro, exceto quando estado é escolhido.
GET https://simcaq.c3sl.ufpr.br/api/v1/cub?filter=min_month:"8"
{
"result":[
{
"sigla_uf":"BR",
"tipo_preco":"CUB R1",
"preco":1927.529259259259
},
{
"sigla_uf":"BR",
"tipo_preco":"CUB R1",
"preco":1932.8233333333335
}
]
}GET https://simcaq.c3sl.ufpr.br/api/v1/cub?filter=min_month:"8",state:"12"
{
"result":[
{
"cod_uf":12,
"sigla_uf":"AC",
"tipo_preco":"CUB R1",
"preco":2083.95
},
{
"cod_uf":12,
"sigla_uf":"AC",
"tipo_preco":"CUB R1",
"preco":2081.62
}
]
}Anos disponíveis do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/cub/years
{
"result":[
{
"year":2017
}
]
}Menor e maior ano disponível do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/cub/year_range
{
"result":[
{
"start_year":2017,
"end_year":2017
}
]
}Meses disponíveis do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/cub/months
{
"result":[
{
"month":8
},
{
"month":9
}
]
}Anos e meses disponíveis do indicador
GET https://simcaq.c3sl.ufpr.br/api/v1/cub/years_months
{
"result":[
{
"year":2017,
"month":8
},
{
"year":2017,
"month":9
}
]
}Indicador: Transporte Escolar
Obter Transporte Escolar
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport
- denominator: número total de matrículas
- partial: número total de matrículas que atendem a condição
- total: percentual de matrículas que atendem a condição
- use_transport_public: utiliza transporte público ou não, aparece apenas no array public_transport
- use_transport: utiliza o transporte especificado no array, aparece em cada array dos diversos tipos de transporte
{
"result":[
{
"public_transport":[
{
"total":48608093,
"name":"Brasil",
"year":2017,
"use_transport_public_id":true,
"percentage":17.811128694145644,
"partial":8657650,
"use_transport_public_name":"Sim"
},
{
"total":48608093,
"name":"Brasil",
"year":2017,
"use_transport_public_id":false,
"percentage":82.18887130585436,
"partial":39950443,
"use_transport_public_name":"Não"
}
],
"van_and_kombi":[
{
"total":8657650,
"name":"Brasil",
"year":2017,
"use_transport_id":true,
"percentage":9.813875589796307,
"partial":849651,
"use_transport_name":"Sim"
},
{
"total":8657650,
"name":"Brasil",
"year":2017,
"use_transport_id":false,
"percentage":90.18612441020369,
"partial":7807999,
"use_transport_name":"Não"
}
],
"micro_bus": [
....
],
"bus": [
....
],
"bike": [
....
],
"animal_traction": [
....
],
"other_vehicle": [
....
]
"waterway_5_Students": [
....
],
"waterway_15_Students": [
....
],
"waterway_35_Students": [
....
],
"waterway_More_Than_35": [
....
],
"subway_and_train": [
....
]
}
]
}Parâmetros
dims
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| school | Adiciona ao resultado o campo da escola | /api/v1/transport?dims=school |
|
| region | Adiciona ao resultado o campo da região | /api/v1/transport?dims=region |
|
| state | Adiciona ao resultado o campo do estado | /api/v1/transport?dims=state |
|
| city | Adiciona ao resultado o campo da cidade | /api/v1/transport?dims=city |
|
| location | Adiciona ao resultado o campo da localização | /api/v1/transport?dims=location |
|
| rural_location | Adiciona ao resultado o campo da localização rural | /api/v1/transport?dims=rural_location |
|
| adm_dependency | Adiciona ao resultado o campo da dependência administrativa | /api/v1/transport?dims=adm_dependency |
|
| adm_dependency_detailed | Adiciona ao resultado o campo da dependência administrativa detalhada | /api/v1/transport?dims=adm_dependency_detailed |
|
| transportation_manager | Adiciona ao resultado o campo poder público responsável pelo transporte escolar | /api/v1/transport?dims=transportation_manager |
|
| service_type | Adiciona ao resultado o campo tipo de atendimento | /api/v1/transport?dims=service_type |
filter
| Parâmetro | Valor | Descrição | Exemplo de URL |
|---|---|---|---|
| region | Integer | Filtra o resultado usando o campo da região | /api/v1/transport?filter=region:2 |
| state | Integer | Filtra o resultado usando o campo do estado | /api/v1/transport?filter=state:41 |
| city | Integer | Filtra o resultado usando o campo da cidade | /api/v1/transport?filter=city:4106902 |
| school | Integer | Filtra o resultado usando o campo da escola | /api/v1/transport?filter=school:41126882 |
| location | Integer | Filtra o resultado usando o campo da localização | /api/v1/transport?filter=location:1 |
| rural_location | Integer | Filtra o resultado usando o campo da localização rural | /api/v1/transport?filter=rural_location:1 |
| adm_dependency | Filtra o resultado usando o campo da dependência administrativa | /api/v1/transport?filter=adm_dependency:1 |
|
| adm_dependency_detailed | Filtra o resultado usando o campo da dependência administrativa detalhada | /api/v1/transport?filter=adm_dependency_detailed:1 |
|
| transportation_manager | Filtra o resultado o campo poder público responsável pelo transporte escolar | /api/v1/transport?filter=transportation_manager:1 |
|
| education_level_basic | Filtra o resultado usando o campo Etapas e modalidades por segmento | /api/v1/transport?filter=education_level_basic:1 |
|
| min_year | Filtra o resultado usando o campo do ano mínimo | /api/v1/transport?filter=min_year:2015 |
|
| max_year | Filtra o resultado usando o campo do ano máximo | /api/v1/transport?filter=max_year:2013 |
|
| service_type | Filtra o resultado o campo tipo de atendimento | /api/v1/transport?dims=service_type:1 |
Fonte do indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/source
{
"result": [
{
"source": "Microdados do Censo Escolar/INEP (arquivo Matrículas)"
}
]
}Anos disponíveis para o indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/years
{
"result":[
{"year":2017},
{"year":2016},
{"year":2015},
{"year":2014},
{"year":2013}
]
}Localizações disponíveis para o indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"}
]
}Localizações rurais disponíveis para o indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/rural_location
{
"result":[
{"id":1,"name":"Urbana"},
{"id":2,"name":"Rural"},
{"id":3,"name":"Rural - Área de assentamento"},
{"id":4,"name":"Rural - Terra indígena"},
{"id":5,"name":"Rural - Área remanescente de quilombos"},
{"id":6,"name":"Rural - Unidade de uso sustentável"}
]
}Poder público responsável pelo transporte escolar
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/transportation_manager
{
"result":[
{"id":null,"name":"Não classificada"},
{"id":1,"name":"Estadual"},
{"id":2,"name":"Municipal"}
]
}Etapas e modalidades por segmento
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/education_level_basic
{
"result":[
{"id":null,"name":"Não classificada"},
{"id":1,"name":"Creche"},
{"id":2,"name":"Pré-Escola"},
{"id":4,"name":"Ensino Fundamental - anos iniciais"},
{"id":5,"name":"Ensino Fundamental - anos finais"},
{"id":6,"name":"Ensino Médio"}
]
}Dependências administrativas disponíveis para o indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/adm_dependency
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"}
]
}Dependências administrativas com detalhamento das escolas privadas disponíveis para o indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/adm_dependency_detailed
{
"result":[
{"id":1,"name":"Federal"},
{"id":2,"name":"Estadual"},
{"id":3,"name":"Municipal"},
{"id":4,"name":"Privada"},
{"id":5,"name":"Privada conveniada"},
{"id":6,"name":"Privada não conveniada sem fins lucrativos"},
{"id":7,"name":"Privada não conveniada com fins lucrativos"},
{"id":99,"name":"Não classificada"}
]
}Tipos de atendimento disponíveis para o indicador
GET https://simcaqdev.c3sl.ufpr.br/api/v1/transport/service_type
{
"result":[
{"id": 0, name: 'Não se aplica'},
{"id": 1, name: 'Classe hospitalar'},
{"id": 2, name: 'Unidade de Atendimento Socioeducativo'},
{"id": 3, name: 'Unidade Prisional'},
{"id": 4, name: 'Atividade Complementar '},
{"id": 5, name: 'Atendimento Educacional Especializado (AEE)'}
]
}