joaomiranda/reservas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
reservas/swagger.json
João Miranda fb04d71a8d
Some checks failed
tests / ci (push) Has been cancelled
Details
first commit
2026-10-27 11:01:11 +00:00

5406 lines
133 KiB
JSON
Raw Permalink Blame History

{
"openapi": "3.0.1",
"info": {
"title": "eSchooling Connector API",
"description": "API REST de leitura para integração com o eSchooling",
"version": "1.3.0"
},
"paths": {
"/api/v1/Agrupamentos": {
"get": {
"tags": [
"Agrupamentos"
],
"parameters": [
{
"name": "pesquisa",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AgrupamentoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgrupamentoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgrupamentoDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Agrupamentos/{id}": {
"get": {
"tags": [
"Agrupamentos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AgrupamentoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgrupamentoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgrupamentoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "turmaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ativo",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AlunoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlunoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AlunoDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Alunos/pesquisa": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "nome",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "numeroAluno",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AlunoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlunoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AlunoDtoPagedResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AlunoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlunoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AlunoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/foto": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FotoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FotoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FotoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/matriculas": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatriculaDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatriculaDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatriculaDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/encarregados": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EncarregadoDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EncarregadoDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EncarregadoDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/faltas": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "disciplinaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FaltaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FaltaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FaltaDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/avaliacoes": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AvaliacaoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AvaliacaoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AvaliacaoDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/classificacoes-modulo": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/classificacoes-modulos": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/assiduidade": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AssiduidadeResumoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssiduidadeResumoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssiduidadeResumoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/recuperacoes": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RecuperacaoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecuperacaoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RecuperacaoDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/assiduidade/recuperacoes": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RecuperacaoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecuperacaoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RecuperacaoDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Alunos/{id}/ocorrencias": {
"get": {
"tags": [
"Alunos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OcorrenciaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OcorrenciaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OcorrenciaDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/anos-letivos": {
"get": {
"tags": [
"AnosLetivos"
],
"parameters": [
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ativo",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AnoLetivoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnoLetivoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AnoLetivoDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/anos-letivos/{id}": {
"get": {
"tags": [
"AnosLetivos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AnoLetivoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnoLetivoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AnoLetivoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/anos-letivos/{id}/calendario": {
"get": {
"tags": [
"AnosLetivos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CalendarioEscolarDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarioEscolarDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CalendarioEscolarDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Catalogos/tipos-falta": {
"get": {
"tags": [
"Catalogos"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TipoFaltaCatalogoDto"
}
}
}
}
}
}
}
},
"/api/v1/Catalogos/estados-matricula": {
"get": {
"tags": [
"Catalogos"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EstadoMatriculaCatalogoDto"
}
}
}
}
}
}
}
},
"/api/v1/Catalogos/componentes-formacao": {
"get": {
"tags": [
"Catalogos"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponenteFormacaoCatalogoDto"
}
}
}
}
}
}
}
},
"/api/v1/Catalogos/motivos-justificacao": {
"get": {
"tags": [
"Catalogos"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MotivoJustificacaoCatalogoDto"
}
}
}
}
}
}
}
},
"/api/v1/Catalogos/tipos-ocorrencia": {
"get": {
"tags": [
"Catalogos"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TipoOcorrenciaCatalogoDto"
}
}
}
}
}
}
}
},
"/api/v1/Cursos": {
"get": {
"tags": [
"Cursos"
],
"parameters": [
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ativo",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CursoDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CursoDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CursoDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Cursos/{id}": {
"get": {
"tags": [
"Cursos"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CursoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CursoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CursoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Disciplinas": {
"get": {
"tags": [
"Disciplinas"
],
"parameters": [
{
"name": "turmaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DisciplinaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisciplinaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DisciplinaDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Disciplinas/{id}": {
"get": {
"tags": [
"Disciplinas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DisciplinaDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisciplinaDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DisciplinaDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Disciplinas/{id}/modulos": {
"get": {
"tags": [
"Disciplinas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuloDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuloDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuloDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Escolas": {
"get": {
"tags": [
"Escolas"
],
"parameters": [
{
"name": "agrupamentoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ativa",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EscolaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EscolaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EscolaDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Escolas/{id}": {
"get": {
"tags": [
"Escolas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EscolaDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EscolaDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EscolaDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/health": {
"get": {
"tags": [
"Meta"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HealthResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Meta"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HealthResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponseDto"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/info": {
"get": {
"tags": [
"Meta"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InfoResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InfoResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InfoResponseDto"
}
}
}
}
}
}
},
"/info": {
"get": {
"tags": [
"Meta"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InfoResponseDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InfoResponseDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InfoResponseDto"
}
}
}
}
}
}
},
"/api/v1/Professores": {
"get": {
"tags": [
"Professores"
],
"parameters": [
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProfessorDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfessorDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProfessorDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Professores/{id}": {
"get": {
"tags": [
"Professores"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProfessorDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfessorDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProfessorDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Professores/{id}/foto": {
"get": {
"tags": [
"Professores"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FotoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FotoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FotoDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Professores/por-email": {
"get": {
"tags": [
"Professores"
],
"parameters": [
{
"name": "email",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProfessorDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfessorDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProfessorDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Professores/{id}/horario": {
"get": {
"tags": [
"Professores"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HorarioItemDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HorarioItemDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HorarioItemDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Sumarios": {
"get": {
"tags": [
"Sumarios"
],
"parameters": [
{
"name": "turmaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "disciplinaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "professorId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "estado",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "moduloId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "de",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SumarioDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SumarioDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SumarioDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Sumarios/{id}": {
"get": {
"tags": [
"Sumarios"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SumarioDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SumarioDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SumarioDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "escolaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "cursoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TurmaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TurmaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TurmaDtoPagedResult"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TurmaDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TurmaDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TurmaDto"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/modulos": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuloDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuloDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuloDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/docentes": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocenteTurmaDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocenteTurmaDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocenteTurmaDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/matriculas": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatriculaDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatriculaDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatriculaDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/faltas": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "disciplinaId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "de",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FaltaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FaltaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FaltaDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/assiduidade": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssiduidadeDisciplinaDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssiduidadeDisciplinaDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssiduidadeDisciplinaDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/classificacoes-modulo": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/classificacoes-modulos": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassificacaoModuloDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/pautas": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PautaDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PautaDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PautaDto"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/Turmas/{id}/ocorrencias": {
"get": {
"tags": [
"Turmas"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "anoLetivoId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "desde",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OcorrenciaDtoPagedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OcorrenciaDtoPagedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OcorrenciaDtoPagedResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AgrupamentoDto": {
"type": "object",
"properties": {
"agrupamentoId": {
"type": "string",
"format": "uuid"
},
"nome": {
"type": "string"
},
"codigoMisi": {
"type": "string",
"nullable": true
},
"totalEscolas": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AgrupamentoDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgrupamentoDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AlunoDto": {
"type": "object",
"properties": {
"alunoId": {
"type": "string",
"format": "uuid"
},
"numeroAluno": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nome": {
"type": "string",
"nullable": true
},
"nomeAbreviado": {
"type": "string",
"nullable": true
},
"maiorDeIdade": {
"type": "boolean",
"nullable": true
},
"ativo": {
"type": "boolean"
},
"turmaAtualId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"turmaAtualNome": {
"type": "string",
"nullable": true
},
"cursoNome": {
"type": "string",
"nullable": true
},
"foto": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AlunoDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AlunoDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AnoLetivoDto": {
"type": "object",
"properties": {
"anoLetivoId": {
"type": "string",
"format": "uuid"
},
"nome": {
"type": "string"
},
"dataInicio": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dataFim": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ativo": {
"type": "boolean"
},
"escolaId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"AnoLetivoDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnoLetivoDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AssiduidadeDisciplinaDto": {
"type": "object",
"properties": {
"alunoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"nomeDisciplina": {
"type": "string",
"nullable": true
},
"moduloId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"faltasTotal": {
"type": "integer",
"format": "int32"
},
"faltasJustificadas": {
"type": "integer",
"format": "int32"
},
"faltasNaoJustificadas": {
"type": "integer",
"format": "int32"
},
"horasFalta": {
"type": "number",
"format": "double"
},
"horasRecuperadas": {
"type": "number",
"format": "double"
},
"horasPorRecuperar": {
"type": "number",
"format": "double"
},
"cargaHorariaMinutos": {
"type": "integer",
"format": "int32"
},
"minutosLecionados": {
"type": "integer",
"format": "int32"
},
"minutosFalta": {
"type": "integer",
"format": "int32"
},
"minutosFaltaJustificada": {
"type": "integer",
"format": "int32"
},
"minutosFaltaInjustificada": {
"type": "integer",
"format": "int32"
},
"minutosRecuperados": {
"type": "integer",
"format": "int32"
},
"percentagemFalta": {
"type": "number",
"format": "double"
},
"limiteUltrapassado": {
"type": "boolean",
"nullable": true
},
"calculadoEm": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"AssiduidadeResumoDto": {
"type": "object",
"properties": {
"alunoId": {
"type": "string",
"format": "uuid"
},
"totalFaltasBloco": {
"type": "integer",
"format": "int32"
},
"faltasJustificadas": {
"type": "integer",
"format": "int32"
},
"faltasNaoJustificadas": {
"type": "integer",
"format": "int32"
},
"totalHorasFalta": {
"type": "number",
"format": "double"
},
"totalHorasRecuperadas": {
"type": "number",
"format": "double"
},
"horasPorRecuperar": {
"type": "number",
"format": "double"
},
"disciplinas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssiduidadeDisciplinaDto"
}
}
},
"additionalProperties": false
},
"AvaliacaoDto": {
"type": "object",
"properties": {
"avaliacaoId": {
"type": "string",
"format": "uuid"
},
"alunoId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"nomeDisciplina": {
"type": "string",
"nullable": true
},
"descricaoPeriodo": {
"type": "string",
"nullable": true
},
"ordemMomento": {
"type": "integer",
"format": "int32"
},
"notaFinal": {
"type": "number",
"format": "double",
"nullable": true
},
"aprovado": {
"type": "boolean"
},
"dataClassificacao": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"AvaliacaoDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvaliacaoDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CalendarioEscolarDto": {
"type": "object",
"properties": {
"anoLetivoId": {
"type": "string",
"format": "uuid"
},
"periodos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PeriodoEscolarDto"
}
},
"interrupcoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterrupcaoEscolarDto"
}
},
"feriados": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeriadoEscolarDto"
}
},
"conselhosTurma": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConselhoTurmaDto"
}
}
},
"additionalProperties": false
},
"ClassificacaoModuloDto": {
"type": "object",
"properties": {
"classificacaoId": {
"type": "string",
"format": "uuid"
},
"alunoId": {
"type": "string",
"format": "uuid"
},
"moduloId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"classificacao": {
"type": "integer",
"format": "int32",
"nullable": true
},
"classificacaoDecimal": {
"type": "number",
"format": "double",
"nullable": true
},
"aprovado": {
"type": "boolean"
},
"epoca": {
"enum": [
"NORMAL",
"RECUPERACAO",
"ESPECIAL"
],
"type": "string",
"description": "Época de avaliação: NORMAL (avaliação contínua / época regular), RECUPERACAO (recuperação de módulo em atraso), ESPECIAL (época especial de conclusão de ciclo / finalistas)."
},
"emVigor": {
"type": "boolean"
},
"tentativa": {
"type": "integer",
"format": "int32"
},
"dataLancamento": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"ClassificacaoModuloDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassificacaoModuloDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ComponenteFormacaoCatalogoDto": {
"type": "object",
"properties": {
"codigo": {
"type": "string"
},
"descricao": {
"type": "string"
}
},
"additionalProperties": false
},
"ConselhoTurmaDto": {
"type": "object",
"properties": {
"periodo": {
"type": "integer",
"format": "int32"
},
"dataInicio": {
"type": "string",
"nullable": true
},
"dataFim": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CursoDto": {
"type": "object",
"properties": {
"cursoId": {
"type": "string",
"format": "uuid"
},
"descricao": {
"type": "string"
},
"abreviatura": {
"type": "string"
},
"escolaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ativo": {
"type": "boolean"
},
"codigoMisi": {
"type": "integer",
"format": "int32",
"nullable": true
},
"tipo": {
"type": "string"
},
"codigoReferencial": {
"type": "string",
"nullable": true
},
"coordenadorId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CursoDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CursoDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DisciplinaDto": {
"type": "object",
"properties": {
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"nome": {
"type": "string"
},
"abreviatura": {
"type": "string"
},
"turmaId": {
"type": "string",
"format": "uuid"
},
"nomeTurma": {
"type": "string"
},
"anoEscolaridade": {
"type": "integer",
"format": "int32",
"nullable": true
},
"componente": {
"type": "string"
},
"cargaHorariaCicloMinutos": {
"type": "integer",
"format": "int32"
},
"cargaHorariaAnoMinutos": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ordem": {
"type": "integer",
"format": "int32",
"nullable": true
},
"disciplinaReferencialId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DisciplinaDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DisciplinaDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DocenteTurmaDto": {
"type": "object",
"properties": {
"turmaId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"professorId": {
"type": "string",
"format": "uuid"
},
"nomeProfessor": {
"type": "string",
"nullable": true
},
"emailProfessor": {
"type": "string",
"nullable": true
},
"nomeDisciplina": {
"type": "string",
"nullable": true
},
"moduloId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dataInicio": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dataFim": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eDiretorTurma": {
"type": "boolean"
},
"foto": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EncarregadoDto": {
"type": "object",
"properties": {
"encarregadoId": {
"type": "string",
"format": "uuid"
},
"alunoId": {
"type": "string",
"format": "uuid"
},
"nome": {
"type": "string",
"nullable": true
},
"parentesco": {
"type": "string"
},
"principal": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"telemovel": {
"type": "string",
"nullable": true
},
"telefone": {
"type": "string",
"nullable": true
},
"foto": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EscolaDto": {
"type": "object",
"properties": {
"escolaId": {
"type": "string",
"format": "uuid"
},
"agrupamentoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"descricao": {
"type": "string"
},
"codigoMisi": {
"type": "string",
"nullable": true
},
"eSedeAgrupamento": {
"type": "boolean"
},
"extinta": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EscolaDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EscolaDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EstadoMatriculaCatalogoDto": {
"type": "object",
"properties": {
"codigo": {
"type": "string"
},
"descricao": {
"type": "string"
}
},
"additionalProperties": false
},
"FaltaDto": {
"type": "object",
"properties": {
"faltaId": {
"type": "string",
"format": "uuid"
},
"alunoId": {
"type": "string",
"format": "uuid"
},
"sumarioId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"nomeDisciplina": {
"type": "string",
"nullable": true
},
"moduloId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"turmaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dataAula": {
"type": "string",
"format": "date-time"
},
"duracaoMinutos": {
"type": "integer",
"format": "int32"
},
"tipoFalta": {
"type": "string",
"nullable": true
},
"tipoFaltaCodigo": {
"type": "string",
"nullable": true
},
"justificada": {
"type": "boolean"
},
"estadoJustificacao": {
"type": "string",
"nullable": true
},
"dataJustificacao": {
"type": "string",
"format": "date-time",
"nullable": true
},
"motivoJustificacao": {
"type": "string",
"nullable": true
},
"motivoJustificacaoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"recuperada": {
"type": "boolean"
},
"recuperacaoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dataRegisto": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"FaltaDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FaltaDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FeriadoEscolarDto": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"nome": {
"type": "string"
}
},
"additionalProperties": false
},
"FotoDto": {
"type": "object",
"properties": {
"entidadeId": {
"type": "string",
"format": "uuid"
},
"mimeType": {
"type": "string"
},
"base64": {
"type": "string"
},
"dataUri": {
"type": "string"
}
},
"additionalProperties": false
},
"HealthResponseDto": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"database": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"serverTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"apiVersion": {
"type": "string"
},
"ultimaSincronizacao": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estadoSincronizacao": {
"type": "string"
},
"proximaSincronizacao": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodicidade": {
"type": "string"
},
"detalhesSincronizacao": {
"$ref": "#/components/schemas/SincronizacaoDetalheDto"
}
},
"additionalProperties": false
},
"HorarioItemDto": {
"type": "object",
"properties": {
"horarioId": {
"type": "string",
"format": "uuid"
},
"professorId": {
"type": "string",
"format": "uuid"
},
"diaSemana": {
"type": "integer",
"format": "int32"
},
"diaSemanaDescricao": {
"type": "string",
"nullable": true
},
"horaInicio": {
"type": "string",
"nullable": true
},
"horaFim": {
"type": "string",
"nullable": true
},
"duracaoMinutos": {
"type": "integer",
"format": "int32"
},
"turmaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"nomeTurma": {
"type": "string",
"nullable": true
},
"disciplinaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"nomeDisciplina": {
"type": "string",
"nullable": true
},
"salaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"nomeSala": {
"type": "string",
"nullable": true
},
"siglaSala": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InfoResponseDto": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string"
},
"database": {
"type": "string"
},
"servidor": {
"type": "string"
}
},
"additionalProperties": false
},
"InterrupcaoEscolarDto": {
"type": "object",
"properties": {
"nome": {
"type": "string"
},
"dataInicio": {
"type": "string",
"nullable": true
},
"dataFim": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MatriculaDto": {
"type": "object",
"properties": {
"matriculaId": {
"type": "string",
"format": "uuid"
},
"alunoId": {
"type": "string",
"format": "uuid"
},
"turmaId": {
"type": "string",
"format": "uuid"
},
"anoLetivoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"numeroNaTurma": {
"type": "integer",
"format": "int32",
"nullable": true
},
"estado": {
"type": "string"
},
"dataInicio": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dataFim": {
"type": "string",
"format": "date-time",
"nullable": true
},
"motivoSaida": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ModuloDto": {
"type": "object",
"properties": {
"moduloId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"turmaId": {
"type": "string",
"format": "uuid"
},
"codigo": {
"type": "string"
},
"nome": {
"type": "string"
},
"ordem": {
"type": "integer",
"format": "int32"
},
"tipo": {
"type": "string"
},
"cargaHorariaMinutos": {
"type": "integer",
"format": "int32"
},
"anoLetivoId": {
"type": "string",
"format": "uuid"
},
"dataInicio": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dataFim": {
"type": "string",
"description": "Data de conclusão do módulo (data da última aula lecionada). Retorna null enquanto o módulo estiver em curso (EM_CURSO) ou por iniciar (POR_INICIAR), sendo preenchida apenas quando o módulo atinge o estado TERMINADO.",
"format": "date-time",
"nullable": true
},
"estado": {
"enum": [
"POR_INICIAR",
"EM_CURSO",
"TERMINADO"
],
"type": "string",
"description": "Estado do módulo: POR_INICIAR (sem aulas sumariadas), EM_CURSO (com aulas dadas mas carga horária incompleta), TERMINADO (carga horária lecionada concluída)."
},
"minutosLecionados": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"MotivoJustificacaoCatalogoDto": {
"type": "object",
"properties": {
"motivoId": {
"type": "string",
"format": "uuid"
},
"codigo": {
"type": "string"
},
"descricao": {
"type": "string"
},
"ativo": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OcorrenciaDto": {
"type": "object",
"properties": {
"ocorrenciaId": {
"type": "string",
"format": "uuid"
},
"alunoId": {
"type": "string",
"format": "uuid"
},
"turmaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"disciplinaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"professorId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"data": {
"type": "string",
"format": "date-time"
},
"dataRegisto": {
"type": "string",
"format": "date-time"
},
"tipo": {
"type": "string"
},
"tipoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"gravidade": {
"type": "string",
"nullable": true
},
"medida": {
"type": "string",
"nullable": true
},
"estado": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OcorrenciaDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OcorrenciaDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PautaDto": {
"type": "object",
"properties": {
"moduloId": {
"type": "string",
"format": "uuid"
},
"turmaId": {
"type": "string",
"format": "uuid"
},
"epoca": {
"enum": [
"NORMAL",
"RECUPERACAO",
"ESPECIAL"
],
"type": "string",
"description": "Época de avaliação: NORMAL (avaliação contínua / época regular), RECUPERACAO (recuperação de módulo em atraso), ESPECIAL (época especial de conclusão de ciclo / finalistas)."
},
"estado": {
"type": "string"
},
"dataLancamento": {
"type": "string",
"format": "date-time",
"nullable": true
},
"professorId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"PeriodoEscolarDto": {
"type": "object",
"properties": {
"ordem": {
"type": "integer",
"format": "int32"
},
"nome": {
"type": "string"
},
"dataInicio": {
"type": "string",
"nullable": true
},
"dataFim": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ProfessorDto": {
"type": "object",
"properties": {
"professorId": {
"type": "string",
"format": "uuid"
},
"nome": {
"type": "string",
"nullable": true
},
"nomeAbreviado": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"ativo": {
"type": "boolean"
},
"numeroME": {
"type": "string",
"nullable": true
},
"numeroCap": {
"type": "string",
"nullable": true
},
"foto": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProfessorDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfessorDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"RecuperacaoDto": {
"type": "object",
"properties": {
"recuperacaoId": {
"type": "string",
"format": "uuid"
},
"sumarioOriginalId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"nomeDisciplina": {
"type": "string",
"nullable": true
},
"moduloId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dataAulaOriginal": {
"type": "string",
"format": "date-time"
},
"duracaoMinutos": {
"type": "integer",
"format": "int32"
},
"dataRecuperacao": {
"type": "string",
"format": "date-time"
},
"horasRecuperadas": {
"type": "number",
"format": "double"
},
"minutosRecuperados": {
"type": "integer",
"format": "int32"
},
"tipo": {
"type": "string",
"nullable": true
},
"estado": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RecuperacaoDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecuperacaoDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SincronizacaoDetalheDto": {
"type": "object",
"properties": {
"duracaoSegundos": {
"type": "integer",
"format": "int32",
"nullable": true
},
"tabelasProcessadas": {
"type": "integer",
"format": "int32",
"nullable": true
},
"totalDiferencasAplicadas": {
"type": "integer",
"format": "int32",
"nullable": true
},
"tabelaMaisLenta": {
"type": "string",
"nullable": true
},
"tabelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TabelaSyncDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"SumarioDto": {
"type": "object",
"properties": {
"sumarioId": {
"type": "string",
"format": "uuid"
},
"disciplinaId": {
"type": "string",
"format": "uuid"
},
"nomeDisciplina": {
"type": "string"
},
"turmaId": {
"type": "string",
"format": "uuid"
},
"nomeTurma": {
"type": "string"
},
"professorId": {
"type": "string",
"format": "uuid"
},
"dataHoraInicio": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dataHoraFim": {
"type": "string",
"format": "date-time",
"nullable": true
},
"duracaoMinutos": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numeroAula": {
"type": "integer",
"format": "int32",
"nullable": true
},
"textoSumario": {
"type": "string",
"nullable": true
},
"faltaProfessor": {
"type": "boolean"
},
"estado": {
"type": "string"
},
"sumariada": {
"type": "boolean"
},
"moduloId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"tipoAula": {
"type": "string"
},
"professorSubstitutoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"salaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"salaNome": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SumarioDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SumarioDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TabelaSyncDto": {
"type": "object",
"properties": {
"tabela": {
"type": "string"
},
"ultimaSincronizacao": {
"type": "string",
"format": "date-time",
"nullable": true
},
"duracaoMs": {
"type": "integer",
"format": "int32"
},
"diferencas": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TipoFaltaCatalogoDto": {
"type": "object",
"properties": {
"codigo": {
"type": "string"
},
"descricao": {
"type": "string"
},
"contaParaAssiduidade": {
"type": "boolean"
},
"eJustificavel": {
"type": "boolean"
},
"ativo": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TipoOcorrenciaCatalogoDto": {
"type": "object",
"properties": {
"tipoId": {
"type": "string",
"format": "uuid"
},
"codigo": {
"type": "string"
},
"descricao": {
"type": "string"
},
"geraFalta": {
"type": "boolean"
},
"eDisciplinar": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TurmaDto": {
"type": "object",
"properties": {
"turmaId": {
"type": "string",
"format": "uuid"
},
"nome": {
"type": "string"
},
"anoEscolaridade": {
"type": "integer",
"format": "int32",
"nullable": true
},
"anoLetivoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"cursoId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"diretorTurmaId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"cicloInicio": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cicloFim": {
"type": "integer",
"format": "int32",
"nullable": true
},
"turmaOrigemId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"secretarioId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"emFct": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TurmaDtoPagedResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TurmaDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"ApiKey": {
"type": "apiKey",
"description": "A API usa chave estática para autenticação. Exemplo: 'X-Api-Key: <chave>'",
"name": "X-Api-Key",
"in": "header"
}
}
},
"security": [
{
"ApiKey": [ ]
}
]
}
Reference in New Issue View Git Blame Copy Permalink