diff --git a/jsonschema/apis/LessonPlanCopyContentToAnotherDisciplineClasses_v1_000.json b/jsonschema/apis/LessonPlanCopyContentToAnotherDisciplineClasses_v1_000.json new file mode 100644 index 0000000000..df1e89c0e0 --- /dev/null +++ b/jsonschema/apis/LessonPlanCopyContentToAnotherDisciplineClasses_v1_000.json @@ -0,0 +1,117 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "description": "API para cópia de conteúdo de plano de aula para outra turma/disciplina", + "url": "{{host}}/api/educational/v1", + "variables": { + "serverUrl": { + "default": "localhost" + }, + "serverHttpPort": { + "default": "8051" + } + } + } + ], + "info": { + "description": "API para cópia de conteúdo de plano de aula para outra turma/disciplina", + "version": "1.000", + "title": "Cópia de conteúdo de plano de aula para outra turma/disciplina", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "LessonPlanCopyContentToAnotherDisciplineClasses", + "description": "Cópia de conteúdo de plano de aula para outra turma/disciplina", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "tribeedu.squad.saga@totvs.com.br", + "description": "Entidade plano de aula, perfil professor" + } + ] + } + }, + "paths": { + "/Professors/{ProfessorInternalId}/LessonPlanCopyContentToAnotherDisciplineClasses": { + "post": { + "tags": [ + "LessonPlanCopyContentToAnotherDisciplineClasses" + ], + "summary": "Cópia de conteúdo de plano de aula para outra turma/disciplina passada na requisição", + "description": "Cópia de conteúdo de plano de aula para outra turma/disciplina passada na requisição", + "operationId": "postLessonPlanCopyContentToAnotherDisciplineClasses", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.32" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToAnotherDisciplineClasses/v1/1_000/jsonschema/schemas/LessonPlanCopyContentToAnotherDisciplineClasses_1_000.json#/definitions/ProfessorLessonPlanContentCopy" + } + } + }, + "description": "Cópia de conteúdo de plano de aula para outra turma/disciplina" + }, + "responses": { + "201": { + "description": "Operação realizada com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToAnotherDisciplineClasses/v1/1_000/jsonschema/schemas/LessonPlanCopyContentToAnotherDisciplineClasses_1_000.json#/definitions/ProfessorLessonPlanContentCopy" + } + } + } + }, + "500": { + "description": "Não foi possível copiar o conteúdo", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "ProfessorInternalId": { + "name": "ProfessorInternalId", + "in": "path", + "required": true, + "description": "InternalId do professor", + "schema": { + "type": "string" + } + } + }, + "schemas": {} + } +} \ No newline at end of file diff --git a/jsonschema/apis/LessonPlanCopyContentToSequencedLessons_v1_000.json b/jsonschema/apis/LessonPlanCopyContentToSequencedLessons_v1_000.json new file mode 100644 index 0000000000..db7b382d49 --- /dev/null +++ b/jsonschema/apis/LessonPlanCopyContentToSequencedLessons_v1_000.json @@ -0,0 +1,117 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "description": "API para cópia do conteúdo para aulas em sequência para a entidade plano de aula (LessonPlan) para produtos TOTVS", + "url": "{{host}}/api/educational/v1", + "variables": { + "serverUrl": { + "default": "localhost" + }, + "serverHttpPort": { + "default": "8051" + } + } + } + ], + "info": { + "description": "API para cópia do conteúdo para aulas em sequência para a entidade plano de aula (LessonPlan) para produtos TOTVS", + "version": "1.000", + "title": "Cópia de conteúdo para aulas em sequência", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "LessonPlanCopyContentToSequencedLessons", + "description": "Cópia do conteúdo de aulas em sequência", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "tribeedu.squad.saga@totvs.com.br", + "description": "Entidade plano de aula, perfíl professor" + } + ] + } + }, + "paths": { + "/Professors/{ProfessorInternalId}/LessonPlansCopyExpectedToRealized": { + "post": { + "tags": [ + "LessonPlanCopyContentToSequencedLessons" + ], + "summary": "Copia o conteúdo para aulas em sequência para o plano de aula passado na requisição", + "description": "Copia o conteúdo para aulas em sequência para o plano de aula passado na requisição", + "operationId": "postLessonPlanCopyContentToSequencedLessons", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.32" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToSequencedLessons/v1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToSequencedLessons/v1/1_000/jsonschema/schemas/LessonPlanCopyContentToSequencedLessons_1_000.json#/definitions/LessonPlanCopyContentToSequencedLessons" + } + } + }, + "description": "Cópia de contaúdo para aulas em sequência" + }, + "responses": { + "201": { + "description": "Operação realizada com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToSequencedLessons/v1/1_000/jsonschema/schemas/LessonPlanCopyContentToSequencedLessons_1_000.json#/definitions/LessonPlanCopyContentToSequencedLessons" + } + } + } + }, + "500": { + "description": "Não foi possível copiar o conteúdo", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "ProfessorInternalId": { + "name": "ProfessorInternalId", + "in": "path", + "required": true, + "description": "InternalId do professor", + "schema": { + "type": "string" + } + } + }, + "schemas": {} + } +} \ No newline at end of file diff --git a/jsonschema/apis/LessonPlanCopyExpectedToRealized_v1_000.json b/jsonschema/apis/LessonPlanCopyExpectedToRealized_v1_000.json new file mode 100644 index 0000000000..9cc571b7fa --- /dev/null +++ b/jsonschema/apis/LessonPlanCopyExpectedToRealized_v1_000.json @@ -0,0 +1,117 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "description": "API para cópia do conteúdo previsto para realizado para a entidade plano de aula (LessonPlan) para produtos TOTVS", + "url": "{{host}}/api/educational/v1", + "variables": { + "serverUrl": { + "default": "localhost" + }, + "serverHttpPort": { + "default": "8051" + } + } + } + ], + "info": { + "description": "API para cópia do conteúdo previsto para realizado para a entidade plano de aula (LessonPlan) para produtos TOTVS", + "version": "1.000", + "title": "Cópia de conteúdo previsto para realizado", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "LessonPlanCopyExpectedToRealized", + "description": "Cópia do conteúdo previsto para o realizado em planos de aula", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "tribeedu.squad.saga@totvs.com.br", + "description": "Entidade plano de aula, perfíl professor" + } + ] + } + }, + "paths": { + "/Professors/{ProfessorInternalId}/LessonPlansCopyExpectedToRealized": { + "post": { + "tags": [ + "LessonPlanCopyExpectedToRealized" + ], + "summary": "Copia o conteúdo previsto para o realizado nos planos de aula passados na requisição", + "description": "Copia o conteúdo previsto para o realizado nos planos de aula passados na requisição", + "operationId": "postLessonPlanCopyExpectedToRealized", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.32" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyExpectedToRealized/v1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyExpectedToRealized/v1/1_000/jsonschema/schemas/LessonPlanCopyExpectedToRealized_1_000.json#/definitions/LessonPlanCopyExpectedToRealized" + } + } + }, + "description": "Cópia do conteúdo previsto para o realizado em planos de aula" + }, + "responses": { + "201": { + "description": "Operação realizada com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyExpectedToRealized/v1/1_000/jsonschema/schemas/LessonPlanCopyExpectedToRealized_1_000.json#/definitions/LessonPlanCopyExpectedToRealized" + } + } + } + }, + "500": { + "description": "Não foi possível copiar o conteúdo previsto para o realizado", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "ProfessorInternalId": { + "name": "ProfessorInternalId", + "in": "path", + "required": true, + "description": "InternalId do professor", + "schema": { + "type": "string" + } + } + }, + "schemas": {} + } +} \ No newline at end of file diff --git a/jsonschema/apis/ProfessorWarningAttachment_v1_000.json b/jsonschema/apis/ProfessorWarningAttachment_v1_000.json new file mode 100644 index 0000000000..db7baab456 --- /dev/null +++ b/jsonschema/apis/ProfessorWarningAttachment_v1_000.json @@ -0,0 +1,291 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "description": "API para a entidade anexos da ocorrência, perfil professor (ProfessorWarningAttachment) para produtos TOTVS", + "url": "{{host}}/api/educational/v1", + "variables": { + "serverUrl": { + "default": "localhost" + }, + "serverHttpPort": { + "default": "8051" + } + } + } + ], + "info": { + "description": "API para a entidade anexos da ocorrência do aluno, cadastrados pelo professor educacional", + "version": "1.000", + "title": "Anexos da ocorrências do aluno - Acesso Professor", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "ProfessorWarningAttachment", + "description": "Anexo da ocorrência do aluno educacional", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "TribeEdu.Squad.EduPortalMobile@totvs.com.br", + "description": "Entidade de anexo de ocorrência educacional, perfil professor" + } + ] + } + }, + "paths": { + "/Professors/{ProfessorInternalId}/studentwarnings/{StudentWarningsInternalId}/StudentWarningAttachments": { + "get": { + "tags": [ + "ProfessorWarningAttachment" + ], + "summary": "Retorna todos os anexos da ocorrência do aluno, cadastrados pelo professor do Educacional", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.31" + } + ] + }, + "description": "Retorna todos os anexos da ocorrência do aluno, cadastrados pelo professor do Educacional", + "operationId": "getAll", + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "#/components/parameters/StudentWarningsInternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize" + } + ], + "responses": { + "200": { + "description": "Operação realizada com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/ProfessorWarningAttachment/v1/1_000/jsonschema/schemas/ProfessorWarningAttachment_1_000.json#/definitions/PagedProfessorWarningAttachment" + } + } + } + }, + "400": { + "description": "erro no momento da listagem dos anexos da ocorrências do aluno", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + }, + "post": { + "tags": [ + "ProfessorWarningAttachment" + ], + "summary": "Inclui o anexo passado na requisição", + "description": "Inclui o anexo passado na requisição", + "operationId": "postProfessorWarningAttachment", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.31" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "#/components/parameters/StudentWarningsInternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + } + ], + "responses": { + "200": { + "description": "Operação realizada com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/ProfessorWarningAttachment/v1/1_000/jsonschema/schemas/ProfessorWarningAttachment_1_000.json#/definitions/ProfessorWarningAttachment" + } + } + } + }, + "404": { + "description": "Anexo não localizado na base", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + } + }, + "/Professors/{ProfessorInternalId}/studentwarnings/{StudentWarningsInternalId}/StudentWarningAttachments/{InternalId}": { + "get": { + "tags": [ + "ProfessorWarningAttachment" + ], + "summary": "Retorna detalhes do anexo da ocorrência do aluno educacional", + "description": "Retorna o anexo da ocorrência do aluno do educacional", + "operationId": "getId", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.31" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "#/components/parameters/StudentWarningsInternalId" + }, + { + "$ref": "#/components/parameters/InternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + } + ], + "responses": { + "200": { + "description": "Operação realizada com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/ProfessorWarningAttachment/v1/1_000/jsonschema/schemas/ProfessorWarningAttachment_1_000.json#/definitions/ProfessorWarningAttachment" + } + } + } + }, + "404": { + "description": "Anexo não localizado na base", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + }, + "delete": { + "tags": [ + "ProfessorWarningAttachment" + ], + "summary": "Exclusão do anexo da ocorrência passado na requisição", + "description": "Exclusão do anexo da ocorrência passado na requisição", + "operationId": "DeleteProfessorWarningAttachment", + "x-totvs": { + "productInformation": [ + { + "product": "RM", + "available": true, + "note": "Este verbo esta disponível com todos os parâmetros", + "minimalVersion": "12.1.31" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/ProfessorInternalId" + }, + { + "$ref": "#/components/parameters/StudentWarningsInternalId" + }, + { + "$ref": "#/components/parameters/InternalId" + }, + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization" + } + ], + "responses": { + "204": { + "description": "Anexo da ocorrência removido com sucesso" + }, + "404": { + "description": "Anexo não localizado na base", + "content": { + "application/json": { + "schema": { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "ProfessorInternalId": { + "name": "ProfessorInternalId", + "in": "path", + "required": true, + "description": "InternalId do professor", + "schema": { + "type": "string" + } + }, + "StudentWarningsInternalId": { + "name": "StudentWarningsInternalId", + "in": "path", + "required": true, + "description": "InternalId da ocorrência do aluno", + "schema": { + "type": "string" + } + }, + "InternalId": { + "name": "InternalId", + "in": "path", + "required": true, + "description": "InternalId do anexo da ocorrência do aluno", + "schema": { + "type": "string" + } + } + }, + "schemas": {} + } +} \ No newline at end of file diff --git a/jsonschema/schemas/LessonPlanCopyContentToAnotherDisciplineClasses_1_000.json b/jsonschema/schemas/LessonPlanCopyContentToAnotherDisciplineClasses_1_000.json new file mode 100644 index 0000000000..182a8315aa --- /dev/null +++ b/jsonschema/schemas/LessonPlanCopyContentToAnotherDisciplineClasses_1_000.json @@ -0,0 +1,984 @@ +{ + "$schema": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToAnotherDisciplineClasses/v1/1_000/jsonschema/schemas/LessonPlanCopyContentToAnotherDisciplineClasses_1_000.json#", + "info": { + "description": "Contrato de Mensagem Padronizada para cópia de conteúdo de plano de aula para outra turma/disciplina", + "version": "1.000", + "title": "LessonPlanCopyContentToAnotherDisciplineClasses", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "LessonPlanCopyContentToAnotherDisciplineClasses", + "description": "Cópia de conteúdo de plano de aula para outra turma/disciplina", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "tribeedu.squad.saga@totvs.com.br", + "description": "Entidade plano de aula, perfil professor" + } + ] + } + }, + "definitions": { + "ProfessorLessonPlanContentCopy": { + "CopyExpectedContent": { + "type": "boolean", + "example": 0, + "description": "Indica se o conteúdo previsto deve ser copiado", + "x-totvs": [ + { + "product": "RM", + "required": false, + "type": "logical", + "available": true, + "canUpdate": false + } + ] + }, + "CopyRealizedContent": { + "type": "boolean", + "example": 0, + "description": "Indica se o conteúdo realizado deve ser copiado", + "x-totvs": [ + { + "product": "RM", + "required": false, + "type": "logical", + "available": true, + "canUpdate": false + } + ] + }, + "CopyHomeWorkContent": { + "type": "boolean", + "example": 0, + "description": "Indica se as lições de casa devem ser copiadas", + "x-totvs": [ + { + "product": "RM", + "required": false, + "type": "logical", + "available": true, + "canUpdate": false + } + ] + }, + "CopyFilesContent": { + "type": "boolean", + "example": 0, + "description": "Indica se os arquivos devem ser copiados", + "x-totvs": [ + { + "product": "RM", + "required": false, + "type": "logical", + "available": true, + "canUpdate": false + } + ] + }, + "SourceLessonPlans": { + "type": "array", + "description": "Planos de aula de origem para o processo de cópia de conteúdo", + "items": { + "$ref": "#/definitions/ProfessorLessonPlan" + } + }, + "DestinationLessonPlans": { + "type": "array", + "description": "Planos de aula de destino para o processo de cópia de conteúdo", + "items": { + "$ref": "#/definitions/ProfessorLessonPlan" + } + }, + "DestinationDisciplineClasses": { + "type": "array", + "description": "Turmas/Disciplinas de destino para o processo de cópia de conteúdo", + "items": { + "type": "integer" + } + } + }, + "ProfessorLessonPlan": { + "description": "Cópia do conteúdo para aulas em sequência em planos de aula", + "properties": { + "CompanyCode": { + "description": "Código da empresa", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "integer" + } + ] + }, + "CompanyInternalId": { + "description": "InternalId da empresa", + "type": "string", + "x-totvs": [ + { + "product": "RM", + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "string", + "required": false, + "available": true + } + ] + }, + "BranchCode": { + "description": "Código da filial", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da filial", + "field": "CODFILIAL", + "type": "integer" + } + ] + }, + "BranchInternalId": { + "description": "InternalId da filial", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "note": "GFILIAL.CODCOLIGADA | GFILIAL.CODFILIAL", + "required": false, + "available": true + } + ] + }, + "LevelEducationCode": { + "type": "integer", + "example": 1, + "description": "Nível de ensino", + "x-totvs": [ + { + "product": "RM", + "Field": "STURMADISC.CODTIPOCURSO", + "required": true, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "LevelEducationInternalId": { + "type": "string", + "description": "InternalId Level Education", + "x-totvs": [ + { + "product": "RM", + "note": "STIPOCURSO.CODCOLIGADA | STIPOCURSO.CODTIPOCURSO", + "required": false, + "available": true + } + ] + }, + "TermCode": { + "type": "integer", + "example": 1, + "description": "Id. do período letivo", + "x-totvs": [ + { + "product": "RM", + "field": "STURMADISC.IDPERLET", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "TermInternalId": { + "type": "string", + "description": "InternalId Term", + "x-totvs": [ + { + "product": "RM", + "note": "SPLETIVO.CODCOLIGADA | SPLETIVO.IDPERLET", + "required": false, + "available": true + } + ] + }, + "DisciplineClassCode": { + "type": "integer", + "example": 1, + "description": "Identificador da turma disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDTURMADISC", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineClassInternalId": { + "type": "string", + "description": "InternalId Discipline Class", + "x-totvs": [ + { + "product": "RM", + "note": "STURMADISC.CODCOLIGADA | STURMADISC.IDTURMADISC", + "required": false, + "available": true + } + ] + }, + "StudentCode": { + "type": "string", + "example": "ES-0001", + "description": "Registro acadêmico", + "x-totvs": [ + { + "product": "RM", + "field": "SALUNO.RA", + "required": true, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "StudentInternalId": { + "type": "string", + "example": "1|ES-0001", + "description": "InternalId Term", + "x-totvs": [ + { + "product": "RM", + "note": "SALUNO.CODCOLIGADA | SALUNO.RA", + "required": false, + "available": true + } + ] + }, + "SpecializationBranchCode": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "Identificador da matriz aplicada", + "x-totvs": [ + { + "product": "RM", + "field": "SHABILITACAOFILIAL.IDHABILITACAOFILIAL", + "required": false, + "type": "integer", + "available": true, + "canUpdate": false + } + ] + }, + "SpecializationBranchInternalId": { + "type": "string", + "example": "1|1", + "description": "InternalId da Matriz aplicada", + "x-totvs": [ + { + "product": "RM", + "note": "SHABILITACAOFILIAL.CODCOLIGADA | SHABILITACAOFILIAL.IDTURMADISC", + "required": false, + "available": true + } + ] + }, + "LessonPlanCode": { + "type": "integer", + "example": 1, + "description": "Identificador do plano de aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDPLANOAULA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "InternalId": { + "type": "string", + "description": "InternalId do plano de aula", + "x-totvs": [ + { + "product": "RM", + "note": "SPLANOAULA.CODCOLIGADA | SPLANOAULA.IDTURMADISC | SPLANOAULA.IDPLANOAULA", + "required": true, + "available": true + } + ] + }, + "Lesson": { + "type": "integer", + "example": 1, + "description": "Número da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.AULA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ClassHourCode": { + "type": "integer", + "example": 1, + "description": "Identificador do horário da turma", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDHORARIOTURMA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ClassHourInternalId": { + "type": "string", + "description": "InternalId Class Hour", + "x-totvs": [ + { + "product": "RM", + "note": "SHORARIO.CODCOLIGADA | SHORARIO.IDHORARIO", + "required": false, + "available": true + } + ] + }, + "ProfessorCode": { + "type": "string", + "example": "000001", + "description": "Código do professor", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODPROF", + "required": false, + "type": "varchar", + "length": 10, + "available": true, + "canUpdate": false + } + ] + }, + "ProfessorInternalId": { + "type": "string", + "description": "InternalId Professor", + "x-totvs": [ + { + "product": "RM", + "note": "SPROFESSOR.CODCOLIGADA | SPROFESSOR.CODPROF", + "required": false, + "available": true + } + ] + }, + "PaymentProfessor": { + "type": "string", + "example": "0", + "description": "Indica qual professor receberá pela aula.", + "enum": [ + "0", + "1", + "2" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.PAGAMENTOPROF", + "note": "0 - Substituto | 1 - Substituido | 2 - Ambos", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "AvailableFrequencyWeb": { + "type": "string", + "example": 1, + "description": "Frequência disp. p/ consulta no portal.", + "enum": [ + "0", + "1" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.FREQUENCIADISPWEB", + "note": "0 - Não | 1 - Sim", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "HourCode": { + "type": "integer", + "example": 1, + "description": "Código do horário do plano de aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODHOR", + "required": false, + "type": "integer", + "format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ExpectedDate": { + "type": "string", + "format": "date", + "example": "1983-10-30", + "description": "Data do plano de aula previsto", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.DATA", + "required": false, + "type": "datetime", + "available": true, + "canUpdate": true + } + ] + }, + "AccomplishedDate": { + "type": "string", + "format": "date", + "example": "1983-10-30", + "description": "Data do plano de aula realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.DATAEFETIVA", + "required": false, + "type": "datetime", + "available": true, + "canUpdate": true + } + ] + }, + "ExpectedContent": { + "type": "string", + "example": "Informe aqui o conteúdo da aula prevista pelo professor", + "description": "Conteúdo da aula prevista", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONTEUDO", + "required": false, + "type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "AccomplishedContent": { + "type": "string", + "example": "Informe aqui o conteúdo da aula realizado", + "description": "Conteúdo da aula realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONTEUDOEFETIVO", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "LessonHome": { + "type": "string", + "example": "Informe aqui o conteúdo a ser realizado em casa/extraclasse", + "description": "Conteúdo a ser realizado em casa/extraclasse", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.LICAOCASA", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "Observation": { + "type": "string", + "example": "Observações sobre o plano de aula", + "description": "Observação", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.OBSERVACAO", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "Replacement": { + "type": "string", + "example": "S", + "description": "Aula é de reposição?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.REPOSICAO", + "note": "N - Não | S -Sim", + "required": false, + "Type": "varchar", + "length": "1", + "available": true, + "canUpdate": true + } + ] + }, + "Surrogate": { + "type": "string", + "example": "S", + "description": "Professor substituto?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.SUBSTITUTO", + "required": false, + "Type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "Confirmed": { + "type": "string", + "example": "S", + "description": "O plano de aula foi confirmado?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONFIRMADO", + "note": "N - Não | S -Sim", + "required": false, + "Type": "Char", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "BuildingCode": { + "type": "string", + "example": "01", + "description": "Código do Prédio", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODPREDIO", + "required": false, + "type": "Char", + "length": 5, + "available": true, + "canUpdate": true + } + ] + }, + "BuildingInternalId": { + "type": "string", + "description": "InternalId Building", + "x-totvs": [ + { + "product": "RM", + "note": "SPREDIO.CODCOLIGADA | SPREDIO.CODFILIAL | SPREDIO.CODPREDIO", + "required": false, + "available": true + } + ] + }, + "BuildingDescription": { + "type": "string", + "example": "Bloco 01", + "description": "Nome do prédio", + "x-totvs": [ + { + "product": "RM", + "field": "SPREDIO.NOME", + "required": false, + "type": "varchar", + "length": 60, + "available": true + } + ] + }, + "BlockCode": { + "type": "string", + "example": "01", + "description": "Código do bloco", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODBLOCO", + "required": false, + "type": "Char", + "length": 5, + "available": true, + "canUpdate": true + } + ] + }, + "BlockInternalId": { + "type": "string", + "description": "InternalId Block", + "x-totvs": [ + { + "product": "RM", + "note": "SBLOCO.CODCOLIGADA | SBLOCO.CODFILIAL | SBLOCO.CODPREDIO | SBLOCO.CODBLOCO", + "required": false, + "available": true + } + ] + }, + "BlockDescription": { + "type": "string", + "example": "Bloco 01", + "description": "Descrição do bloco", + "x-totvs": [ + { + "product": "RM", + "field": "SBLOCO.DESCRICAO", + "required": false, + "type": "varchar", + "length": 50, + "available": true + } + ] + }, + "RoomCode": { + "type": "string", + "example": "01", + "description": "Código da sala", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODSALA", + "required": false, + "type": "integer", + "length": 10, + "available": true, + "canUpdate": true + } + ] + }, + "RoomInternalId": { + "type": "string", + "description": "InternalId Block", + "x-totvs": [ + { + "product": "RM", + "note": "SSALA.CODCOLIGADA | SSALA.CODFILIAL | SSALA.CODPREDIO | SSALA.CODBLOCO | SSALA.CODSALA", + "required": false, + "available": true + } + ] + }, + "RoomDescription": { + "type": "string", + "example": "Sala 01", + "description": "Descrição da sala", + "x-totvs": [ + { + "product": "RM", + "field": "SSALA.DESCRICAO", + "required": false, + "type": "varchar", + "length": 60, + "available": true + } + ] + }, + "Weekday": { + "type": "string", + "example": 1, + "description": "Dia da semana", + "enum": [ + "1", + "2", + "3", + "4", + "5", + "6", + "7" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.DIASEMANA", + "note": "1 - Domingo | 2 - Segunda | 3 - Terça | 4 - Quarta | 5 - Quinta | 6 - Sexta | 7 - Sábado", + "required": false, + "type": "integer", + "available": true, + "canUpdate": false + } + ] + }, + "StartTime": { + "type": "string", + "example": "12:00", + "description": "Hora de início da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAINICIO", + "note": "Campo calculado", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "EndTime": { + "type": "string", + "example": "12:00", + "description": "Hora final da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAFINAL", + "note": "Campo calculado", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "AccomplishedStartTime": { + "type": "string", + "example": "12:00", + "description": "Hora de início da aula - realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAINICIO", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "AccomplishedEndTime": { + "type": "string", + "example": "12:00", + "description": "Hora final da aula - realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAFINAL", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "ClassType": { + "type": "string", + "example": "T", + "description": "Tipo da aula", + "enum": [ + "T", + "P", + "L", + "E" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.TIPOAULA", + "note": "T - Teorica | P - Prática | L - Laboratório | E - Estágio", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": false + } + ] + }, + "ShortageType": { + "type": "string", + "example": "B", + "description": "Tipo de falta do professor", + "enum": [ + "B", + "D", + "J", + "F", + "A" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.TIPOFALTA", + "note": "B - Abono | D - Devolução | J - Justificada | F - Não justificada | A - Atraso", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "Class": { + "type": "string", + "example": "2018-001", + "description": "Código da turma", + "x-totvs": [ + { + "product": "RM", + "field": "STURMA.CODTURMA", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineCode": { + "type": "string", + "example": "001", + "description": "Código da disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "STURMADISC.CODDISC", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineInternalId": { + "type": "string", + "description": "InternalId Discipline", + "x-totvs": [ + { + "product": "RM", + "note": "SDISCIPLINA.CODCOLIGADA | SDISCIPLINA.CODDISC", + "required": false, + "available": true + } + ] + }, + "DisciplineDescription": { + "type": "string", + "example": "Matemática", + "description": "Descrição da disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "SDISCIPLINA.NOME", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "SubClass": { + "type": "string", + "example": "001", + "description": "Descrição da sub turma", + "x-totvs": [ + { + "product": "RM", + "field": "SSUBTURMA.NOME", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "StepCode": { + "type": "string", + "example": "1", + "description": "Código da etapa", + "x-totvs": [ + { + "product": "RM", + "field": "SETAPAS.CODETAPA", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": false + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/jsonschema/schemas/LessonPlanCopyContentToSequencedLessons_1_000.json b/jsonschema/schemas/LessonPlanCopyContentToSequencedLessons_1_000.json new file mode 100644 index 0000000000..a89ac77ab2 --- /dev/null +++ b/jsonschema/schemas/LessonPlanCopyContentToSequencedLessons_1_000.json @@ -0,0 +1,912 @@ +{ + "$schema": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyContentToSequencedLessons/v1/1_000/jsonschema/schemas/LessonPlanCopyContentToSequencedLessons_1_000.json#", + "info": { + "description": "Contrato de Mensagem Padronizada para cópia do conteúdo para aulas em sequência nos planos de aula dos produtos TOTVS", + "version": "1.000", + "title": "LessonPlanCopyContentToSequencedLessons", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "LessonPlanCopyContentToSequencedLessons", + "description": "Cópia do conteúdo para aulas em sequência em planos de aula", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "tribeedu.squad.saga@totvs.com.br", + "description": "Entidade plano de aula, perfíl professor" + } + ] + } + }, + "definitions": { + "LessonPlanCopyContentToSequencedLessons": { + "description": "Cópia do conteúdo para aulas em sequência em planos de aula", + "properties": { + "_expandables": { + "type": "array", + "description": "Expandable property/field list", + "items": { + "type": "string" + } + }, + "CompanyCode": { + "description": "Código da empresa", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "integer" + } + ] + }, + "CompanyInternalId": { + "description": "InternalId da empresa", + "type": "string", + "x-totvs": [ + { + "product": "RM", + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "string", + "required": false, + "available": true + } + ] + }, + "BranchCode": { + "description": "Código da filial", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da filial", + "field": "CODFILIAL", + "type": "integer" + } + ] + }, + "BranchInternalId": { + "description": "InternalId da filial", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "note": "GFILIAL.CODCOLIGADA | GFILIAL.CODFILIAL", + "required": false, + "available": true + } + ] + }, + "LevelEducationCode": { + "type": "integer", + "example": 1, + "description": "Nível de ensino", + "x-totvs": [ + { + "product": "RM", + "Field": "STURMADISC.CODTIPOCURSO", + "required": true, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "LevelEducationInternalId": { + "type": "string", + "description": "InternalId Level Education", + "x-totvs": [ + { + "product": "RM", + "note": "STIPOCURSO.CODCOLIGADA | STIPOCURSO.CODTIPOCURSO", + "required": false, + "available": true + } + ] + }, + "TermCode": { + "type": "integer", + "example": 1, + "description": "Id. do período letivo", + "x-totvs": [ + { + "product": "RM", + "field": "STURMADISC.IDPERLET", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "TermInternalId": { + "type": "string", + "description": "InternalId Term", + "x-totvs": [ + { + "product": "RM", + "note": "SPLETIVO.CODCOLIGADA | SPLETIVO.IDPERLET", + "required": false, + "available": true + } + ] + }, + "DisciplineClassCode": { + "type": "integer", + "example": 1, + "description": "Identificador da turma disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDTURMADISC", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineClassInternalId": { + "type": "string", + "description": "InternalId Discipline Class", + "x-totvs": [ + { + "product": "RM", + "note": "STURMADISC.CODCOLIGADA | STURMADISC.IDTURMADISC", + "required": false, + "available": true + } + ] + }, + "StudentCode": { + "type": "string", + "example": "ES-0001", + "description": "Registro acadêmico", + "x-totvs": [ + { + "product": "RM", + "field": "SALUNO.RA", + "required": true, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "StudentInternalId": { + "type": "string", + "example": "1|ES-0001", + "description": "InternalId Term", + "x-totvs": [ + { + "product": "RM", + "note": "SALUNO.CODCOLIGADA | SALUNO.RA", + "required": false, + "available": true + } + ] + }, + "SpecializationBranchCode": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "Identificador da matriz aplicada", + "x-totvs": [ + { + "product": "RM", + "field": "SHABILITACAOFILIAL.IDHABILITACAOFILIAL", + "required": false, + "type": "integer", + "available": true, + "canUpdate": false + } + ] + }, + "SpecializationBranchInternalId": { + "type": "string", + "example": "1|1", + "description": "InternalId da Matriz aplicada", + "x-totvs": [ + { + "product": "RM", + "note": "SHABILITACAOFILIAL.CODCOLIGADA | SHABILITACAOFILIAL.IDTURMADISC", + "required": false, + "available": true + } + ] + }, + "LessonPlanCode": { + "type": "integer", + "example": 1, + "description": "Identificador do plano de aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDPLANOAULA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "InternalId": { + "type": "string", + "description": "InternalId do plano de aula", + "x-totvs": [ + { + "product": "RM", + "note": "SPLANOAULA.CODCOLIGADA | SPLANOAULA.IDTURMADISC | SPLANOAULA.IDPLANOAULA", + "required": true, + "available": true + } + ] + }, + "Lesson": { + "type": "integer", + "example": 1, + "description": "Número da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.AULA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ClassHourCode": { + "type": "integer", + "example": 1, + "description": "Identificador do horário da turma", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDHORARIOTURMA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ClassHourInternalId": { + "type": "string", + "description": "InternalId Class Hour", + "x-totvs": [ + { + "product": "RM", + "note": "SHORARIO.CODCOLIGADA | SHORARIO.IDHORARIO", + "required": false, + "available": true + } + ] + }, + "ProfessorCode": { + "type": "string", + "example": "000001", + "description": "Código do professor", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODPROF", + "required": false, + "type": "varchar", + "length": 10, + "available": true, + "canUpdate": false + } + ] + }, + "ProfessorInternalId": { + "type": "string", + "description": "InternalId Professor", + "x-totvs": [ + { + "product": "RM", + "note": "SPROFESSOR.CODCOLIGADA | SPROFESSOR.CODPROF", + "required": false, + "available": true + } + ] + }, + "PaymentProfessor": { + "type": "string", + "example": "0", + "description": "Indica qual professor receberá pela aula.", + "enum": [ + "0", + "1", + "2" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.PAGAMENTOPROF", + "note": "0 - Substituto | 1 - Substituido | 2 - Ambos", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "AvailableFrequencyWeb": { + "type": "string", + "example": 1, + "description": "Frequência disp. p/ consulta no portal.", + "enum": [ + "0", + "1" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.FREQUENCIADISPWEB", + "note": "0 - Não | 1 - Sim", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "HourCode": { + "type": "integer", + "example": 1, + "description": "Código do horário do plano de aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODHOR", + "required": false, + "type": "integer", + "format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ExpectedDate": { + "type": "string", + "format": "date", + "example": "1983-10-30", + "description": "Data do plano de aula previsto", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.DATA", + "required": false, + "type": "datetime", + "available": true, + "canUpdate": true + } + ] + }, + "AccomplishedDate": { + "type": "string", + "format": "date", + "example": "1983-10-30", + "description": "Data do plano de aula realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.DATAEFETIVA", + "required": false, + "type": "datetime", + "available": true, + "canUpdate": true + } + ] + }, + "ExpectedContent": { + "type": "string", + "example": "Informe aqui o conteúdo da aula prevista pelo professor", + "description": "Conteúdo da aula prevista", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONTEUDO", + "required": false, + "type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "AccomplishedContent": { + "type": "string", + "example": "Informe aqui o conteúdo da aula realizado", + "description": "Conteúdo da aula realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONTEUDOEFETIVO", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "LessonHome": { + "type": "string", + "example": "Informe aqui o conteúdo a ser realizado em casa/extraclasse", + "description": "Conteúdo a ser realizado em casa/extraclasse", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.LICAOCASA", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "Observation": { + "type": "string", + "example": "Observações sobre o plano de aula", + "description": "Observação", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.OBSERVACAO", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "Replacement": { + "type": "string", + "example": "S", + "description": "Aula é de reposição?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.REPOSICAO", + "note": "N - Não | S -Sim", + "required": false, + "Type": "varchar", + "length": "1", + "available": true, + "canUpdate": true + } + ] + }, + "Surrogate": { + "type": "string", + "example": "S", + "description": "Professor substituto?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.SUBSTITUTO", + "required": false, + "Type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "Confirmed": { + "type": "string", + "example": "S", + "description": "O plano de aula foi confirmado?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONFIRMADO", + "note": "N - Não | S -Sim", + "required": false, + "Type": "Char", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "BuildingCode": { + "type": "string", + "example": "01", + "description": "Código do Prédio", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODPREDIO", + "required": false, + "type": "Char", + "length": 5, + "available": true, + "canUpdate": true + } + ] + }, + "BuildingInternalId": { + "type": "string", + "description": "InternalId Building", + "x-totvs": [ + { + "product": "RM", + "note": "SPREDIO.CODCOLIGADA | SPREDIO.CODFILIAL | SPREDIO.CODPREDIO", + "required": false, + "available": true + } + ] + }, + "BuildingDescription": { + "type": "string", + "example": "Bloco 01", + "description": "Nome do prédio", + "x-totvs": [ + { + "product": "RM", + "field": "SPREDIO.NOME", + "required": false, + "type": "varchar", + "length": 60, + "available": true + } + ] + }, + "BlockCode": { + "type": "string", + "example": "01", + "description": "Código do bloco", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODBLOCO", + "required": false, + "type": "Char", + "length": 5, + "available": true, + "canUpdate": true + } + ] + }, + "BlockInternalId": { + "type": "string", + "description": "InternalId Block", + "x-totvs": [ + { + "product": "RM", + "note": "SBLOCO.CODCOLIGADA | SBLOCO.CODFILIAL | SBLOCO.CODPREDIO | SBLOCO.CODBLOCO", + "required": false, + "available": true + } + ] + }, + "BlockDescription": { + "type": "string", + "example": "Bloco 01", + "description": "Descrição do bloco", + "x-totvs": [ + { + "product": "RM", + "field": "SBLOCO.DESCRICAO", + "required": false, + "type": "varchar", + "length": 50, + "available": true + } + ] + }, + "RoomCode": { + "type": "string", + "example": "01", + "description": "Código da sala", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODSALA", + "required": false, + "type": "integer", + "length": 10, + "available": true, + "canUpdate": true + } + ] + }, + "RoomInternalId": { + "type": "string", + "description": "InternalId Block", + "x-totvs": [ + { + "product": "RM", + "note": "SSALA.CODCOLIGADA | SSALA.CODFILIAL | SSALA.CODPREDIO | SSALA.CODBLOCO | SSALA.CODSALA", + "required": false, + "available": true + } + ] + }, + "RoomDescription": { + "type": "string", + "example": "Sala 01", + "description": "Descrição da sala", + "x-totvs": [ + { + "product": "RM", + "field": "SSALA.DESCRICAO", + "required": false, + "type": "varchar", + "length": 60, + "available": true + } + ] + }, + "Weekday": { + "type": "string", + "example": 1, + "description": "Dia da semana", + "enum": [ + "1", + "2", + "3", + "4", + "5", + "6", + "7" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.DIASEMANA", + "note": "1 - Domingo | 2 - Segunda | 3 - Terça | 4 - Quarta | 5 - Quinta | 6 - Sexta | 7 - Sábado", + "required": false, + "type": "integer", + "available": true, + "canUpdate": false + } + ] + }, + "StartTime": { + "type": "string", + "example": "12:00", + "description": "Hora de início da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAINICIO", + "note": "Campo calculado", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "EndTime": { + "type": "string", + "example": "12:00", + "description": "Hora final da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAFINAL", + "note": "Campo calculado", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "AccomplishedStartTime": { + "type": "string", + "example": "12:00", + "description": "Hora de início da aula - realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAINICIO", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "AccomplishedEndTime": { + "type": "string", + "example": "12:00", + "description": "Hora final da aula - realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAFINAL", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "ClassType": { + "type": "string", + "example": "T", + "description": "Tipo da aula", + "enum": [ + "T", + "P", + "L", + "E" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.TIPOAULA", + "note": "T - Teorica | P - Prática | L - Laboratório | E - Estágio", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": false + } + ] + }, + "ShortageType": { + "type": "string", + "example": "B", + "description": "Tipo de falta do professor", + "enum": [ + "B", + "D", + "J", + "F", + "A" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.TIPOFALTA", + "note": "B - Abono | D - Devolução | J - Justificada | F - Não justificada | A - Atraso", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "Class": { + "type": "string", + "example": "2018-001", + "description": "Código da turma", + "x-totvs": [ + { + "product": "RM", + "field": "STURMA.CODTURMA", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineCode": { + "type": "string", + "example": "001", + "description": "Código da disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "STURMADISC.CODDISC", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineInternalId": { + "type": "string", + "description": "InternalId Discipline", + "x-totvs": [ + { + "product": "RM", + "note": "SDISCIPLINA.CODCOLIGADA | SDISCIPLINA.CODDISC", + "required": false, + "available": true + } + ] + }, + "DisciplineDescription": { + "type": "string", + "example": "Matemática", + "description": "Descrição da disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "SDISCIPLINA.NOME", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "SubClass": { + "type": "string", + "example": "001", + "description": "Descrição da sub turma", + "x-totvs": [ + { + "product": "RM", + "field": "SSUBTURMA.NOME", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "StepCode": { + "type": "string", + "example": "1", + "description": "Código da etapa", + "x-totvs": [ + { + "product": "RM", + "field": "SETAPAS.CODETAPA", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": false + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/jsonschema/schemas/LessonPlanCopyExpectedToRealized_1_000.json b/jsonschema/schemas/LessonPlanCopyExpectedToRealized_1_000.json new file mode 100644 index 0000000000..a6f57f3490 --- /dev/null +++ b/jsonschema/schemas/LessonPlanCopyExpectedToRealized_1_000.json @@ -0,0 +1,912 @@ +{ + "$schema": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/LessonPlanCopyExpectedToRealized/v1/1_000/jsonschema/schemas/LessonPlanCopyExpectedToRealized_1_000.json#", + "info": { + "description": "Contrato de Mensagem Padronizada para cópia do conteúdo previsto para realizado nos planos de aula dos produtos TOTVS", + "version": "1.000", + "title": "LessonPlanCopyExpectedToRealized", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "LessonPlanCopyExpectedToRealized", + "description": "Cópia do conteúdo previsto para o realizado em planos de aula", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "tribeedu.squad.saga@totvs.com.br", + "description": "Entidade plano de aula, perfíl professor" + } + ] + } + }, + "definitions": { + "LessonPlanCopyExpectedToRealized": { + "description": "Cópia do conteúdo previsto para o realizado em planos de aula", + "properties": { + "_expandables": { + "type": "array", + "description": "Expandable property/field list", + "items": { + "type": "string" + } + }, + "CompanyCode": { + "description": "Código da empresa", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "integer" + } + ] + }, + "CompanyInternalId": { + "description": "InternalId da empresa", + "type": "string", + "x-totvs": [ + { + "product": "RM", + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "string", + "required": false, + "available": true + } + ] + }, + "BranchCode": { + "description": "Código da filial", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da filial", + "field": "CODFILIAL", + "type": "integer" + } + ] + }, + "BranchInternalId": { + "description": "InternalId da filial", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "note": "GFILIAL.CODCOLIGADA | GFILIAL.CODFILIAL", + "required": false, + "available": true + } + ] + }, + "LevelEducationCode": { + "type": "integer", + "example": 1, + "description": "Nível de ensino", + "x-totvs": [ + { + "product": "RM", + "Field": "STURMADISC.CODTIPOCURSO", + "required": true, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "LevelEducationInternalId": { + "type": "string", + "description": "InternalId Level Education", + "x-totvs": [ + { + "product": "RM", + "note": "STIPOCURSO.CODCOLIGADA | STIPOCURSO.CODTIPOCURSO", + "required": false, + "available": true + } + ] + }, + "TermCode": { + "type": "integer", + "example": 1, + "description": "Id. do período letivo", + "x-totvs": [ + { + "product": "RM", + "field": "STURMADISC.IDPERLET", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "TermInternalId": { + "type": "string", + "description": "InternalId Term", + "x-totvs": [ + { + "product": "RM", + "note": "SPLETIVO.CODCOLIGADA | SPLETIVO.IDPERLET", + "required": false, + "available": true + } + ] + }, + "DisciplineClassCode": { + "type": "integer", + "example": 1, + "description": "Identificador da turma disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDTURMADISC", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineClassInternalId": { + "type": "string", + "description": "InternalId Discipline Class", + "x-totvs": [ + { + "product": "RM", + "note": "STURMADISC.CODCOLIGADA | STURMADISC.IDTURMADISC", + "required": false, + "available": true + } + ] + }, + "StudentCode": { + "type": "string", + "example": "ES-0001", + "description": "Registro acadêmico", + "x-totvs": [ + { + "product": "RM", + "field": "SALUNO.RA", + "required": true, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "StudentInternalId": { + "type": "string", + "example": "1|ES-0001", + "description": "InternalId Term", + "x-totvs": [ + { + "product": "RM", + "note": "SALUNO.CODCOLIGADA | SALUNO.RA", + "required": false, + "available": true + } + ] + }, + "SpecializationBranchCode": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "Identificador da matriz aplicada", + "x-totvs": [ + { + "product": "RM", + "field": "SHABILITACAOFILIAL.IDHABILITACAOFILIAL", + "required": false, + "type": "integer", + "available": true, + "canUpdate": false + } + ] + }, + "SpecializationBranchInternalId": { + "type": "string", + "example": "1|1", + "description": "InternalId da Matriz aplicada", + "x-totvs": [ + { + "product": "RM", + "note": "SHABILITACAOFILIAL.CODCOLIGADA | SHABILITACAOFILIAL.IDTURMADISC", + "required": false, + "available": true + } + ] + }, + "LessonPlanCode": { + "type": "integer", + "example": 1, + "description": "Identificador do plano de aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDPLANOAULA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "InternalId": { + "type": "string", + "description": "InternalId do plano de aula", + "x-totvs": [ + { + "product": "RM", + "note": "SPLANOAULA.CODCOLIGADA | SPLANOAULA.IDTURMADISC | SPLANOAULA.IDPLANOAULA", + "required": true, + "available": true + } + ] + }, + "Lesson": { + "type": "integer", + "example": 1, + "description": "Número da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.AULA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ClassHourCode": { + "type": "integer", + "example": 1, + "description": "Identificador do horário da turma", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.IDHORARIOTURMA", + "required": false, + "Type": "integer", + "Format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ClassHourInternalId": { + "type": "string", + "description": "InternalId Class Hour", + "x-totvs": [ + { + "product": "RM", + "note": "SHORARIO.CODCOLIGADA | SHORARIO.IDHORARIO", + "required": false, + "available": true + } + ] + }, + "ProfessorCode": { + "type": "string", + "example": "000001", + "description": "Código do professor", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODPROF", + "required": false, + "type": "varchar", + "length": 10, + "available": true, + "canUpdate": false + } + ] + }, + "ProfessorInternalId": { + "type": "string", + "description": "InternalId Professor", + "x-totvs": [ + { + "product": "RM", + "note": "SPROFESSOR.CODCOLIGADA | SPROFESSOR.CODPROF", + "required": false, + "available": true + } + ] + }, + "PaymentProfessor": { + "type": "string", + "example": "0", + "description": "Indica qual professor receberá pela aula.", + "enum": [ + "0", + "1", + "2" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.PAGAMENTOPROF", + "note": "0 - Substituto | 1 - Substituido | 2 - Ambos", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "AvailableFrequencyWeb": { + "type": "string", + "example": 1, + "description": "Frequência disp. p/ consulta no portal.", + "enum": [ + "0", + "1" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.FREQUENCIADISPWEB", + "note": "0 - Não | 1 - Sim", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "HourCode": { + "type": "integer", + "example": 1, + "description": "Código do horário do plano de aula", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODHOR", + "required": false, + "type": "integer", + "format": "int32", + "available": true, + "canUpdate": false + } + ] + }, + "ExpectedDate": { + "type": "string", + "format": "date", + "example": "1983-10-30", + "description": "Data do plano de aula previsto", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.DATA", + "required": false, + "type": "datetime", + "available": true, + "canUpdate": true + } + ] + }, + "AccomplishedDate": { + "type": "string", + "format": "date", + "example": "1983-10-30", + "description": "Data do plano de aula realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.DATAEFETIVA", + "required": false, + "type": "datetime", + "available": true, + "canUpdate": true + } + ] + }, + "ExpectedContent": { + "type": "string", + "example": "Informe aqui o conteúdo da aula prevista pelo professor", + "description": "Conteúdo da aula prevista", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONTEUDO", + "required": false, + "type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "AccomplishedContent": { + "type": "string", + "example": "Informe aqui o conteúdo da aula realizado", + "description": "Conteúdo da aula realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONTEUDOEFETIVO", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "LessonHome": { + "type": "string", + "example": "Informe aqui o conteúdo a ser realizado em casa/extraclasse", + "description": "Conteúdo a ser realizado em casa/extraclasse", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.LICAOCASA", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "Observation": { + "type": "string", + "example": "Observações sobre o plano de aula", + "description": "Observação", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.OBSERVACAO", + "required": false, + "Type": "varchar", + "available": true, + "canUpdate": true + } + ] + }, + "Replacement": { + "type": "string", + "example": "S", + "description": "Aula é de reposição?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.REPOSICAO", + "note": "N - Não | S -Sim", + "required": false, + "Type": "varchar", + "length": "1", + "available": true, + "canUpdate": true + } + ] + }, + "Surrogate": { + "type": "string", + "example": "S", + "description": "Professor substituto?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.SUBSTITUTO", + "required": false, + "Type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "Confirmed": { + "type": "string", + "example": "S", + "description": "O plano de aula foi confirmado?", + "enum": [ + "N", + "S" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CONFIRMADO", + "note": "N - Não | S -Sim", + "required": false, + "Type": "Char", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "BuildingCode": { + "type": "string", + "example": "01", + "description": "Código do Prédio", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODPREDIO", + "required": false, + "type": "Char", + "length": 5, + "available": true, + "canUpdate": true + } + ] + }, + "BuildingInternalId": { + "type": "string", + "description": "InternalId Building", + "x-totvs": [ + { + "product": "RM", + "note": "SPREDIO.CODCOLIGADA | SPREDIO.CODFILIAL | SPREDIO.CODPREDIO", + "required": false, + "available": true + } + ] + }, + "BuildingDescription": { + "type": "string", + "example": "Bloco 01", + "description": "Nome do prédio", + "x-totvs": [ + { + "product": "RM", + "field": "SPREDIO.NOME", + "required": false, + "type": "varchar", + "length": 60, + "available": true + } + ] + }, + "BlockCode": { + "type": "string", + "example": "01", + "description": "Código do bloco", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODBLOCO", + "required": false, + "type": "Char", + "length": 5, + "available": true, + "canUpdate": true + } + ] + }, + "BlockInternalId": { + "type": "string", + "description": "InternalId Block", + "x-totvs": [ + { + "product": "RM", + "note": "SBLOCO.CODCOLIGADA | SBLOCO.CODFILIAL | SBLOCO.CODPREDIO | SBLOCO.CODBLOCO", + "required": false, + "available": true + } + ] + }, + "BlockDescription": { + "type": "string", + "example": "Bloco 01", + "description": "Descrição do bloco", + "x-totvs": [ + { + "product": "RM", + "field": "SBLOCO.DESCRICAO", + "required": false, + "type": "varchar", + "length": 50, + "available": true + } + ] + }, + "RoomCode": { + "type": "string", + "example": "01", + "description": "Código da sala", + "x-totvs": [ + { + "product": "RM", + "field": "SPLANOAULA.CODSALA", + "required": false, + "type": "integer", + "length": 10, + "available": true, + "canUpdate": true + } + ] + }, + "RoomInternalId": { + "type": "string", + "description": "InternalId Block", + "x-totvs": [ + { + "product": "RM", + "note": "SSALA.CODCOLIGADA | SSALA.CODFILIAL | SSALA.CODPREDIO | SSALA.CODBLOCO | SSALA.CODSALA", + "required": false, + "available": true + } + ] + }, + "RoomDescription": { + "type": "string", + "example": "Sala 01", + "description": "Descrição da sala", + "x-totvs": [ + { + "product": "RM", + "field": "SSALA.DESCRICAO", + "required": false, + "type": "varchar", + "length": 60, + "available": true + } + ] + }, + "Weekday": { + "type": "string", + "example": 1, + "description": "Dia da semana", + "enum": [ + "1", + "2", + "3", + "4", + "5", + "6", + "7" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.DIASEMANA", + "note": "1 - Domingo | 2 - Segunda | 3 - Terça | 4 - Quarta | 5 - Quinta | 6 - Sexta | 7 - Sábado", + "required": false, + "type": "integer", + "available": true, + "canUpdate": false + } + ] + }, + "StartTime": { + "type": "string", + "example": "12:00", + "description": "Hora de início da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAINICIO", + "note": "Campo calculado", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "EndTime": { + "type": "string", + "example": "12:00", + "description": "Hora final da aula", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAFINAL", + "note": "Campo calculado", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "AccomplishedStartTime": { + "type": "string", + "example": "12:00", + "description": "Hora de início da aula - realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAINICIO", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "AccomplishedEndTime": { + "type": "string", + "example": "12:00", + "description": "Hora final da aula - realizado", + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.HORAFINAL", + "required": false, + "type": "varchar", + "length": 5, + "available": true, + "canUpdate": false + } + ] + }, + "ClassType": { + "type": "string", + "example": "T", + "description": "Tipo da aula", + "enum": [ + "T", + "P", + "L", + "E" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.TIPOAULA", + "note": "T - Teorica | P - Prática | L - Laboratório | E - Estágio", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": false + } + ] + }, + "ShortageType": { + "type": "string", + "example": "B", + "description": "Tipo de falta do professor", + "enum": [ + "B", + "D", + "J", + "F", + "A" + ], + "x-totvs": [ + { + "product": "RM", + "field": "SHORARIO.TIPOFALTA", + "note": "B - Abono | D - Devolução | J - Justificada | F - Não justificada | A - Atraso", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": true + } + ] + }, + "Class": { + "type": "string", + "example": "2018-001", + "description": "Código da turma", + "x-totvs": [ + { + "product": "RM", + "field": "STURMA.CODTURMA", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineCode": { + "type": "string", + "example": "001", + "description": "Código da disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "STURMADISC.CODDISC", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "DisciplineInternalId": { + "type": "string", + "description": "InternalId Discipline", + "x-totvs": [ + { + "product": "RM", + "note": "SDISCIPLINA.CODCOLIGADA | SDISCIPLINA.CODDISC", + "required": false, + "available": true + } + ] + }, + "DisciplineDescription": { + "type": "string", + "example": "Matemática", + "description": "Descrição da disciplina", + "x-totvs": [ + { + "product": "RM", + "field": "SDISCIPLINA.NOME", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "SubClass": { + "type": "string", + "example": "001", + "description": "Descrição da sub turma", + "x-totvs": [ + { + "product": "RM", + "field": "SSUBTURMA.NOME", + "required": false, + "type": "varchar", + "length": 20, + "available": true, + "canUpdate": false + } + ] + }, + "StepCode": { + "type": "string", + "example": "1", + "description": "Código da etapa", + "x-totvs": [ + { + "product": "RM", + "field": "SETAPAS.CODETAPA", + "required": false, + "type": "varchar", + "length": 1, + "available": true, + "canUpdate": false + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/jsonschema/schemas/ProfessorWarningAttachment_1_000.json b/jsonschema/schemas/ProfessorWarningAttachment_1_000.json new file mode 100644 index 0000000000..91caa4af9a --- /dev/null +++ b/jsonschema/schemas/ProfessorWarningAttachment_1_000.json @@ -0,0 +1,173 @@ +{ + "$schema": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/ProfessorWarningAttachment/v1/1_000/jsonschema/schemas/ProfessorWarning_1_000.json#", + "info": { + "description": "Contrato de Mensagem Padronizada para listagem dos anexos da ocorrência do aluno dos produtos TOTVS", + "version": "1.000", + "title": "ProfessorWarningAttachment", + "contact": { + "name": "T-Talk", + "url": "API.Totvs.com.br", + "email": "comiteintegracao@totvs.com.br" + }, + "x-totvs": { + "messageDocumentation": { + "name": "ProfessorWarningAttachment", + "description": "Dados do anexo da ocorrência do aluno do educacional", + "segment": "Educacional" + }, + "productInformation": [ + { + "product": "RM", + "contact": "TribeEdu.Squad.SAGA@totvs.com.br@totvs.com.br", + "description": "Anexo da ocorrência do aluno do Educacional" + } + ] + } + }, + "definitions": { + "PagedProfessorWarningAttachment": { + "type": "object", + "allOf": [ + { + "$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/Paging" + }, + { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/ProfessorWarningAttachment" + } + } + } + } + ] + }, + "ProfessorWarningAttachment": { + "description": "Descreve um anexo de uma ocorrência do aluno do Educacional", + "properties": { + "CompanyCode": { + "description": "Código da empresa", + "type": "string", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Código da empresa", + "field": "CODCOLIGADA", + "type": "integer" + } + ] + }, + "StudentWarningFileCode": { + "description": "Id do anexo da ocorrência", + "type": "int", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Id do anexo da ocorrência", + "field": "SOCORRENCIAALUNOARQ.IDARQUIVOOCORALUNO", + "type": "integer" + } + ] + }, + "InternalId": { + "type": "string", + "description": "InternalId da anexo da ocorrência", + "x-totvs": [ + { + "product": "RM", + "note": "SOCORRENCIAALUNOARQ.CODCOLIGADA | SOCORRENCIAALUNOARQ.IDARQUIVOOCORALUNO", + "required": true, + "available": true + } + ] + }, + "StudentWarningCode": { + "description": "Id da ocorrência", + "type": "int", + "example": 1, + "x-totvs": [ + { + "product": "RM", + "available": true, + "required": true, + "note": "Id da ocorrência", + "field": "SOCORRENCIAALUNOARQ.IDOCORALUNO", + "type": "integer" + } + ] + }, + "FileName": { + "type": "string", + "example": "ArquivoOcorrencia.txt", + "description": "Nome do arquivo da ocorrência", + "x-totvs": [ + { + "product": "RM", + "field": "SOCORRENCIAALUNOARQ.NOMEARQUIVO", + "note": "Nome do arquivo da ocorrência", + "required": false, + "Type": "string", + "available": true, + "canUpdate": true + } + ] + }, + "Description": { + "type": "string", + "example": "Descrição do arquivo", + "description": "Descrição do arquivo da ocorrência", + "x-totvs": [ + { + "product": "RM", + "field": "SOCORRENCIAALUNOARQ.DESCARQUIVO", + "note": "Descrição do arquivo da ocorrência", + "required": false, + "Type": "string", + "available": true, + "canUpdate": true + } + ] + }, + "File": { + "type": "image", + "description": "Arquivo da ocorrência", + "x-totvs": [ + { + "product": "RM", + "field": "SOCORRENCIAALUNOARQ.ARQUIVO", + "note": "Arquivo da ocorrência", + "required": true, + "Type": "image", + "available": true, + "canUpdate": true + } + ] + }, + "FileSize": { + "type": "int", + "example": "1", + "description": "Tamanho do arquivo", + "x-totvs": [ + { + "product": "RM", + "field": "SOCORRENCIAALUNOARQ.TAMANHOARQUIVO", + "note": "Tamanho do arquivo", + "required": true, + "Type": "int", + "available": true, + "canUpdate": true + } + ] + } + } + } + } +} \ No newline at end of file