{"swagger":"2.0","info":{"title":"EscolaAberta","description":"Na plataforma Escola Aberta você não apenas encontra as escolas municipais de São Paulo mais próximas ou faz uma busca por nome ou por endereço. Para cada escola, é possível consultar também as principais estatísticas: saber, por exemplo, as séries, períodos, quantidade de turmas e de estudantes, vagas oferecidas e atendidas, quantos e quais profissionais trabalham lá, que ambientes a escola possui e como está a avaliação dela no Índice de Desenvolvimento da Educação (IDEP).","contact":{"name":"Secretaria Municipal de Educação"},"version":"v1"},"paths":{"/api/alunosserieturno/{codesc}":{"get":{"operationId":"alunosserieturno_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de alunos por serie e turno por escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de alunos por serie e turno por escola, conforme o Encontre uma escola do portalSME","tags":["alunosserieturno"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/ambientes/":{"get":{"operationId":"ambientes_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"}],"description":"Endpoint responsavel por retornar todos os ambientes, ou retornar ambientes de uma determinada escola","summary":"Endpoint responsavel por retornar todos os ambientes, ou retornar ambientes de uma determinada escola","tags":["ambientes"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/ambientes/{codesc}/":{"get":{"operationId":"ambientes_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint responsavel por retornar todos os ambientes, ou retornar ambientes de uma determinada escola","summary":"Endpoint responsavel por retornar todos os ambientes, ou retornar ambientes de uma determinada escola","tags":["ambientes"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/ambientesbyescola/{codesc}":{"get":{"operationId":"ambientesbyescola_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de ambientes por escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de ambientes por escola, conforme o Encontre uma escola do portalSME","tags":["ambientesbyescola"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/bairros/":{"get":{"operationId":"bairros_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"bairro","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas os bairros,\nfiltrar pelo nome do bairros","summary":"Endpoint responsável por retornar todas os bairros,","tags":["bairros"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/bairros/{codesc}/":{"get":{"operationId":"bairros_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"A unique value identifying this escolas.","type":"string"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"bairro","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas os bairros,\nfiltrar pelo nome do bairros","summary":"Endpoint responsável por retornar todas os bairros,","tags":["bairros"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/diretorias/":{"get":{"operationId":"diretorias_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna as diretorias","summary":"Endpoint que retorna as diretorias","tags":["diretorias"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/distritos/":{"get":{"operationId":"distritos_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"distrito","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas os distritos,\nfiltrar pelo nome do distritos","summary":"Endpoint responsável por retornar todas os distritos,","tags":["distritos"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/distritos/{codesc}/":{"get":{"operationId":"distritos_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"A unique value identifying this escolas.","type":"string"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"distrito","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas os distritos,\nfiltrar pelo nome do distritos","summary":"Endpoint responsável por retornar todas os distritos,","tags":["distritos"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/dtatualizacao/":{"get":{"operationId":"dtatualizacao_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna a data de atualização das informações","summary":"Endpoint que retorna a data de atualização das informações","tags":["dtatualizacao"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/escolas/":{"get":{"operationId":"escolas_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"dre","required":false,"in":"query","description":"","type":"string"},{"name":"tipoesc","required":false,"in":"query","description":"","type":"string"},{"name":"distrito","required":false,"in":"query","description":"","type":"string"},{"name":"bairro","required":false,"in":"query","description":"","type":"string"},{"name":"subpref","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas as escolas,\nfiltrar pro Codigo da escola ou realizar pesquisa por nome da escola","summary":"Endpoint responsável por retornar todas as escolas,","tags":["escolas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/escolas/{codesc}/":{"get":{"operationId":"escolas_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"A unique value identifying this escolas.","type":"string"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"dre","required":false,"in":"query","description":"","type":"string"},{"name":"tipoesc","required":false,"in":"query","description":"","type":"string"},{"name":"distrito","required":false,"in":"query","description":"","type":"string"},{"name":"bairro","required":false,"in":"query","description":"","type":"string"},{"name":"subpref","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas as escolas,\nfiltrar pro Codigo da escola ou realizar pesquisa por nome da escola","summary":"Endpoint responsável por retornar todas as escolas,","tags":["escolas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/livroaberto_escolas/":{"get":{"operationId":"livroaberto_escolas_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint utilizado pelo livro aberto que retorna todas informações\ndas escolas com quantidade de vagas oferecidas","summary":"Endpoint utilizado pelo livro aberto que retorna todas informações","tags":["livroaberto_escolas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/localizador":{"get":{"operationId":"localizador_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que realiza o calculo das distancias das escolas baseado na latitude e longitude\nretorna as top n escolas mais proximas dentro de um determinano raio\n:param lat: latitude do endereço\n:param lon: longitude do endereço\n:param radius: raio de delimitação\n:param top: numero de escolas para retornar","summary":"Endpoint que realiza o calculo das distancias das escolas baseado na latitude e longitude","tags":["localizador"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/modalidades/{codesc}":{"get":{"operationId":"modalidades_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza as modalidades de uma determinada escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza as modalidades de uma determinada escola, conforme o Encontre uma escola do portalSME","tags":["modalidades"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/seriesestudantes/{codesc}":{"get":{"operationId":"seriesestudantes_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de matriculados por turma, serie e turno\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de matriculados por turma, serie e turno","tags":["seriesestudantes"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/servatuacao/{codesc}":{"get":{"operationId":"servatuacao_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza os servidores e sua atuação por escola,\n conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza os servidores e sua atuação por escola,","tags":["servatuacao"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/servidores/":{"get":{"operationId":"servidores_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"}],"description":"Endpoint responsavel por retornar todos os servidores, ou retornar servidores de uma determinada escola","summary":"Endpoint responsavel por retornar todos os servidores, ou retornar servidores de uma determinada escola","tags":["servidores"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/servidores/{codesc}/":{"get":{"operationId":"servidores_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint responsavel por retornar todos os servidores, ou retornar servidores de uma determinada escola","summary":"Endpoint responsavel por retornar todos os servidores, ou retornar servidores de uma determinada escola","tags":["servidores"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smeambientes/":{"get":{"operationId":"smeambientes_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna os dados dos ambientes da REDE ou por DRE","summary":"Endpoint que retorna os dados dos ambientes da REDE ou por DRE","tags":["smeambientes"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smeambientes/{cod_dre}":{"get":{"operationId":"smeambientes_read","responses":{"200":{"description":""}},"parameters":[{"name":"cod_dre","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que retorna os dados dos ambientes da REDE ou por DRE","summary":"Endpoint que retorna os dados dos ambientes da REDE ou por DRE","tags":["smeambientes"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smeescolas/":{"get":{"operationId":"smeescolas_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna os dados de matricula por escola da REDE ou por DRE","summary":"Endpoint que retorna os dados de matricula por escola da REDE ou por DRE","tags":["smeescolas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smeescolas/{cod_dre}":{"get":{"operationId":"smeescolas_read","responses":{"200":{"description":""}},"parameters":[{"name":"cod_dre","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que retorna os dados de matricula por escola da REDE ou por DRE","summary":"Endpoint que retorna os dados de matricula por escola da REDE ou por DRE","tags":["smeescolas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smeprofissionais/":{"get":{"operationId":"smeprofissionais_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna os dados dos servidores da REDE ou por DRE","summary":"Endpoint que retorna os dados dos servidores da REDE ou por DRE","tags":["smeprofissionais"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smeprofissionais/{cod_dre}":{"get":{"operationId":"smeprofissionais_read","responses":{"200":{"description":""}},"parameters":[{"name":"cod_dre","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que retorna os dados dos servidores da REDE ou por DRE","summary":"Endpoint que retorna os dados dos servidores da REDE ou por DRE","tags":["smeprofissionais"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smevagasmat/":{"get":{"operationId":"smevagasmat_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna os dados de vagas e matriculas da REDE ou por DRE","summary":"Endpoint que retorna os dados de vagas e matriculas da REDE ou por DRE","tags":["smevagasmat"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/smevagasmat/{cod_dre}":{"get":{"operationId":"smevagasmat_read","responses":{"200":{"description":""}},"parameters":[{"name":"cod_dre","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que retorna os dados de vagas e matriculas da REDE ou por DRE","summary":"Endpoint que retorna os dados de vagas e matriculas da REDE ou por DRE","tags":["smevagasmat"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/subpref/":{"get":{"operationId":"subpref_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"subpref","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas os subprefeituras,\nfiltrar pelo nome do subprefeituras","summary":"Endpoint responsável por retornar todas os subprefeituras,","tags":["subpref"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/subpref/{codesc}/":{"get":{"operationId":"subpref_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"A unique value identifying this escolas.","type":"string"},{"name":"search","required":false,"in":"query","description":"A search term.","type":"string"},{"name":"subpref","required":false,"in":"query","description":"","type":"string"}],"description":"Endpoint responsável por retornar todas os subprefeituras,\nfiltrar pelo nome do subprefeituras","summary":"Endpoint responsável por retornar todas os subprefeituras,","tags":["subpref"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/tipo_escola/":{"get":{"operationId":"tipo_escola_list","responses":{"200":{"description":""}},"parameters":[],"description":"Endpoint que retorna os tipos de escola","summary":"Endpoint que retorna os tipos de escola","tags":["tipo_escola"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/totservatuacao/{codesc}":{"get":{"operationId":"totservatuacao_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de servidores e sua atuação por escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de servidores e sua atuação por escola, conforme o Encontre uma escola do portalSME","tags":["totservatuacao"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/totservescolarizacao/{codesc}":{"get":{"operationId":"totservescolarizacao_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de servidores e sua escolaridade por escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de servidores e sua escolaridade por escola, conforme o Encontre uma escola do portalSME","tags":["totservescolarizacao"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/totvagmatbyserie/{codesc}":{"get":{"operationId":"totvagmatbyserie_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de vagas e matriculas por serie e escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de vagas e matriculas por serie e escola, conforme o Encontre uma escola do portalSME","tags":["totvagmatbyserie"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/turmas/":{"get":{"operationId":"turmas_list","responses":{"200":{"description":""}},"parameters":[{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","type":"integer"}],"description":"A simple ViewSet for viewing and editing accounts.","summary":"A simple ViewSet for viewing and editing accounts.","tags":["turmas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/turmas/{codturm}/":{"get":{"operationId":"turmas_read","responses":{"200":{"description":""}},"parameters":[{"name":"codturm","required":true,"in":"path","description":"A unique value identifying this turmas.","type":"string"}],"description":"A simple ViewSet for viewing and editing accounts.","summary":"A simple ViewSet for viewing and editing accounts.","tags":["turmas"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}},"/api/turmaserieturno/{codesc}":{"get":{"operationId":"turmaserieturno_read","responses":{"200":{"description":""}},"parameters":[{"name":"codesc","required":true,"in":"path","description":"","type":"string"}],"description":"Endpoint que disponibiliza um totalizador de turmas por serie e turno por escola, conforme o Encontre uma escola do portalSME\n:param codesc: Codigo da escola","summary":"Endpoint que disponibiliza um totalizador de turmas por serie e turno por escola, conforme o Encontre uma escola do portalSME","tags":["turmaserieturno"],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}}},"securityDefinitions":{"basic":{"type":"basic"},"default":{"type":"oauth2","authorizationUrl":"https://gateway.apilib.prefeitura.sp.gov.br/authorize","flow":"implicit","scopes":{}}},"host":"gateway.apilib.prefeitura.sp.gov.br","basePath":"/sme/EscolaAberta/v1","schemes":["https","http"]}