Asignaturas
Asignaturas de una institución.
Lee una asignatura
GET /disciplinas/{disciplinaId}
Acceso: Exige la capacidad LER sobre asignatura (params.disciplinaId). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
disciplinaId | string (uuid) | sí | Id de la asignatura. |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
instituicaoId | string (uuid) | sí | ||
sigla | string | sí | ||
nome | string | sí | ||
ementa | string o nulo | sí | ||
semanas | integer o nulo | sí | ||
ativo | boolean | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/disciplinas/{disciplinaId}" -H "Authorization: Bearer $TOKEN"Actualiza una asignatura
PATCH /disciplinas/{disciplinaId}
Acceso: Exige la capacidad CADASTRAR sobre asignatura (params.disciplinaId). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
disciplinaId | string (uuid) | sí | Id de la asignatura. |
Cuerpo de la solicitud (DisciplinaAtualizar)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
sigla | string | no | ^[A-Za-z0-9][A-Za-z0-9._-]{0,14}$ | |
nome | string | no | 1–200 caracteres | |
ementa | string o nulo | no | a 10000 caracteres | |
semanas | integer o nulo | no | 1…520 | |
ativo | boolean | no |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
instituicaoId | string (uuid) | sí | ||
sigla | string | sí | ||
nome | string | sí | ||
ementa | string o nulo | sí | ||
semanas | integer o nulo | sí | ||
ativo | boolean | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X PATCH "$API/disciplinas/{disciplinaId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'Lista las asignaturas de una institución
GET /instituicoes/{instituicaoId}/disciplinas
Acceso: Exige la capacidad LER, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
instituicaoId | string (uuid) | sí | Id de la institución. |
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
busca | string | no | a 100 caracteres | Texto para buscar (nombre o correo, según la ruta). |
limite | integer | no | 1…200; por defecto: 50 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
deslocamento | integer | no | 0…100000; por defecto: 0 | Cuántos elementos saltar, para paginar (hasta 100000). |
inativos | "true" | "false" | no | por defecto: "false" | true incluye también los registros inactivos. |
Respuesta
lista de DisciplinaDto (+ total)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
instituicaoId | string (uuid) | sí | ||
sigla | string | sí | ||
nome | string | sí | ||
ementa | string o nulo | sí | ||
semanas | integer o nulo | sí | ||
ativo | boolean | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/instituicoes/{instituicaoId}/disciplinas" -H "Authorization: Bearer $TOKEN"Crea una asignatura en la institución
POST /instituicoes/{instituicaoId}/disciplinas
sigla y nome son únicos en la institución: repetir devuelve 409 taken.
Acceso: Exige la capacidad CADASTRAR sobre institución (params.instituicaoId). Estado de éxito: 201.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
instituicaoId | string (uuid) | sí | Id de la institución. |
Cuerpo de la solicitud (DisciplinaCriar)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
sigla | string | sí | ^[A-Za-z0-9][A-Za-z0-9._-]{0,14}$ | |
nome | string | sí | 1–200 caracteres | |
ementa | string o nulo | no | a 10000 caracteres | |
semanas | integer o nulo | no | 1…520 |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
instituicaoId | string (uuid) | sí | ||
sigla | string | sí | ||
nome | string | sí | ||
ementa | string o nulo | sí | ||
semanas | integer o nulo | sí | ||
ativo | boolean | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X POST "$API/instituicoes/{instituicaoId}/disciplinas" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"sigla":"texto","nome":"texto"}'