-
Notifications
You must be signed in to change notification settings - Fork 2
API: Recurso Estudantes
Método: GET
URL: /api/students
| Nome | Tipo | Descrição | Exemplos |
|---|---|---|---|
| name | String | Busca por nome. | 'LUCAS SOUZA' (nome exato), 'LUCAS%' (começa com 'LUCAS'), '%SOUZA%' (contém 'SOUZA') |
| registrationNumber | String | Busca por matrícula | '201504940001' |
| minCrg | Number | Busca por CRG mínimo | 5 |
| maxCrg | Number | Busca por CRG máximo | 8 |
| eqCrg | Number | Busca por CRG exato | 7 |
| course | 'cbcc' ou 'cbsi' | Busca por curso | cbcc |
| String | Busca por email | 'foo@example.com' | |
| isFit | Boolean | Busca por aptidão | 0, 1 |
| isConcluding | Boolean | Busca por conclusão do curso | 0, 1 |
| isActive | Boolean | Busca por atividade | 0, 1 |
| isForming | Boolean | Busca por formandos | 0, 1 |
| isGraduating | Boolean | Busca por graduação | 0, 1 |
| academicHighlight | Boolean | Busca por destaques acadêmicos | 0, 1 |
| cancelled | Boolean | Busca por alunos cancelados | 0, 1 |
| prescribed | Boolean | Busca por alunos prescritos | 1 |
| mailingList | User#mailingList | Busca por lista de email | 'active', 'graduating'... |
| noDefense | Boolean | Quando true, retorna apenas alunos sem defesa. |
Status: 200
Corpo: Array de Student
Método: GET
URL: /api/students/:id
id: Chave primária do estudante.
Status: 200
Corpo: Student
Método: GET
URL: /api/students/?sort=parameter&order=disposition
parameter: name para ordenar pelo nome ou registrationNumber para ordenar pela matrícula.
disposition: asc para ordenar no sentido crescente ou desc para ordenar no sentido decrescente.
Status: 200
Corpo: Array de Student
Método: GET
URL: /api/students/email-changes?mailingList=?
mailingList: active, concluding, freshman.
Status: 200
Corpo:
{
"additions": [
{
"id": "identificador",
"name": "Nome",
"email": "email@example.com",
"type":"student|solicitation"
}
],
"deletions": [
{
"id": "identificador",
"name": "Nome",
"email": "email@example.com",
"type":"student|solicitation"
}
]
}Método: POST
URL: /api/students/update-mailing-list
mailingList: 'active', 'concluding', 'freshman'.
type: 'add', 'remove'
studentIds: Array com identificadores dos estudantes
solicitationIds: Array com identificadores das solicitações
Status: 200
Corpo:
{
"additions": 10,
"deletions": 5
}Método: GET
URL: /api/students/:id/concluding-certificate
id: Chave primária do estudante.
Status: 200
Corpo: Stream (pdf)
Método: GET
URL: /api/students/:course/attendance-register
course: 'cbcc' ou 'cbsi'.
Status: 200
Corpo: Stream (pdf)