GET v1/alunos?nomeEscola={nomeEscola}&dataBase={dataBase}
Descrição: Retorna lista de alunos por escola levando em consideração apenas alunos ativos -- Utilização: URL_API/alunos?nomeEscola=1 -- Parametros: nomeEscola = nome da escola
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
nomeEscola | nome da escola |
Define this parameter in the request URI. |
dataBase | Data base para os filtros |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
[ { "status": 1, "cod_matricula": "sample string 2", "cod_aluno": "sample string 3", "aluno": "sample string 4", "dataNascimento": "2025-04-03T18:04:58.0037081-03:00", "turma": "sample string 6", "serie": "sample string 7", "curso": "sample string 8", "codigoEscola": "sample string 9", "turno": "sample string 10" }, { "status": 1, "cod_matricula": "sample string 2", "cod_aluno": "sample string 3", "aluno": "sample string 4", "dataNascimento": "2025-04-03T18:04:58.0037081-03:00", "turma": "sample string 6", "serie": "sample string 7", "curso": "sample string 8", "codigoEscola": "sample string 9", "turno": "sample string 10" }, { "status": 1, "cod_matricula": "sample string 2", "cod_aluno": "sample string 3", "aluno": "sample string 4", "dataNascimento": "2025-04-03T18:04:58.0037081-03:00", "turma": "sample string 6", "serie": "sample string 7", "curso": "sample string 8", "codigoEscola": "sample string 9", "turno": "sample string 10" } ]
text/xml
Sample:
<ArrayOfDadosAlunoAtivo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSTech.GestaoEscolar.ObjetosSincronizacao.Entities"> <DadosAlunoAtivo> <aluno>sample string 4</aluno> <cod_aluno>sample string 3</cod_aluno> <cod_matricula>sample string 2</cod_matricula> <codigoEscola>sample string 9</codigoEscola> <curso>sample string 8</curso> <dataNascimento>2025-04-03T18:04:58.0037081-03:00</dataNascimento> <serie>sample string 7</serie> <status>1</status> <turma>sample string 6</turma> <turno>sample string 10</turno> </DadosAlunoAtivo> <DadosAlunoAtivo> <aluno>sample string 4</aluno> <cod_aluno>sample string 3</cod_aluno> <cod_matricula>sample string 2</cod_matricula> <codigoEscola>sample string 9</codigoEscola> <curso>sample string 8</curso> <dataNascimento>2025-04-03T18:04:58.0037081-03:00</dataNascimento> <serie>sample string 7</serie> <status>1</status> <turma>sample string 6</turma> <turno>sample string 10</turno> </DadosAlunoAtivo> <DadosAlunoAtivo> <aluno>sample string 4</aluno> <cod_aluno>sample string 3</cod_aluno> <cod_matricula>sample string 2</cod_matricula> <codigoEscola>sample string 9</codigoEscola> <curso>sample string 8</curso> <dataNascimento>2025-04-03T18:04:58.0037081-03:00</dataNascimento> <serie>sample string 7</serie> <status>1</status> <turma>sample string 6</turma> <turno>sample string 10</turno> </DadosAlunoAtivo> </ArrayOfDadosAlunoAtivo>
text/csv
Sample:
Sample not available.