privado
185
edições
Mudanças
De UltramaxWiki
Gestão Escolar - API de integração (ver código-fonte)
Edição das 18h31min de 7 de abril de 2022
, 18h31min de 7 de abril de 2022sem sumário de edição
Linha 105:
Linha 105:
+
+Endereco:
+
+
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
+
+Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
{| class="wikitable"
Linha 206:
Linha 208:
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
+
+Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
{| class="wikitable"
Linha 312:
Linha 316:
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
+
+Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
{| class="wikitable"
Linha 319:
Linha 325:
|Tamanho
|Tamanho
|-
|-
−|'''codigoUnidade'''
+|codigoUnidade
|Código da unidade de ensino que o curso pertence.
|Código da unidade de ensino que o curso pertence.
|Número
|Número
|
|
|-
|-
−|'''periodoLeletivo'''
+|periodoLeletivo
|Descrição do período Letivo atual
|Descrição do período Letivo atual
|Texto
|Texto
|20
|20
|-
|-
−|'''sigla'''
+|sigla
|Código do curso
|Código do curso
|Texto
|Texto
|15
|15
|-
|-
−|'''nomeCurso'''
+|nomeCurso
|Nome do curso
|Nome do curso
|Texto
|Texto
|70
|70
|-
|-
−|'''numeroSerieDeMatricula'''
+|numeroSerieDeMatricula
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
|Número
|Número
|
|
|-
|-
−|'''nomeSerie'''
+|nomeSerie
|Nome da série
|Nome da série
|Texto
|Texto
|70
|70
|-
|-
−|'''nomeTurma'''
+|nomeTurma
|Nome da turma
|Nome da turma
|Texto
|Texto
Linha 409:
Linha 415:
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
Status 412: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo
+
+Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
Linha 415:
Linha 423:
|Tamanho
|Tamanho
|-
|-
−|'''cpf_cnpj'''
+|cpf_cnpj
|CPF do aluno que será gerada a matrícula, apenas numeros
|CPF do aluno que será gerada a matrícula, apenas numeros
|Número
|Número
|
|
|-
|-
−|'''codigoIntegracao'''
+|codigoIntegracao
|Código de integração para um Curso existente
|Código de integração para um Curso existente
|Número
|Número
|
|
|-
|-
−|'''codigoMatriculaUnico'''
+|codigoMatriculaUnico
|Código de integração para busca de uma matrícula ou para criar uma nova
|Código de integração para busca de uma matrícula ou para criar uma nova
|Texto
|Texto
|255
|255
|-
|-
−|'''codigoUnidade'''
+|codigoUnidade
|Código da unidade de ensino que o curso pertence.
|Código da unidade de ensino que o curso pertence.
|
|
|
|
|-
|-
−|'''numeroSerieDeMatricula'''
+|numeroSerieDeMatricula
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha três séries e a matrícula deve ser feita no primeira delas, deve passar 1
|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha três séries e a matrícula deve ser feita no primeira delas, deve passar 1
|Número
|Número
|
|
|-
|-
−|'''valor'''
+|valor
|Valor total do curso. Ex. 1000.0 definido para a série
|Valor total do curso. Ex. 1000.0 definido para a série
|Número
|Número
|
|
|-
|-
−|'''quantidadeParcelas'''
+|quantidadeParcelas
|Quantidade de parcelas de parcelas padrão configurado para a série
|Quantidade de parcelas de parcelas padrão configurado para a série
|Número
|Número
|
|
|-
|-
−|'''origem'''
+|origem
|Origem da matrícula, como padrão "Plataforma EAD"
|Origem da matrícula, como padrão "Plataforma EAD"
|Texto
|Texto
|20
|20
|-
|-
−|'''títulos'''
+|títulos
|Títulos gerados para a matrícula
|Títulos gerados para a matrícula
|Titulo*
|Titulo*
|1..N
|1..N
|-
|-
−|'''Aluno'''
+|Aluno
|Dados básicos do aluno que devem ser considerados no retorno da matricula
|Dados básicos do aluno que devem ser considerados no retorno da matricula
|Aluno*
|Aluno*
|1..1
|1..1
|-
|-
−|'''StatusMatricula'''
+|StatusMatricula
|Status atual da matrícula
|Status atual da matrícula
|Texto
|Texto
|30
|30
|-
|-
−|'''periodoLetivo'''
+|periodoLetivo
|Descrição do período letivo
|Descrição do período letivo
|Texto
|Texto
|20
|20
|-
|-
−|'''sigla'''
+|sigla
|Código do curso referente a matrícula
|Código do curso referente a matrícula
|Texto
|Texto
|15
|15
|-
|-
−|'''Turmas'''
+|Turmas
|Arrays de turmas que a matrícula pertence
|Arrays de turmas que a matrícula pertence
|Turma*
|Turma*
|1..N
|1..N
|}
|}
+''*Os tipos de dados estão definidos abaixo''
−Responsavel:
+==== Responsavel: ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
Linha 547:
Linha 556:
|bit
|bit
|1
|1
−|}Aluno:
+|}
+==== Aluno: ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
Linha 646:
Linha 657:
|
|
|}
|}
−Estado:
+==== Estado: ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
Linha 663:
Linha 675:
|30
|30
|}
|}
−==== Endereco: ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
Linha 706:
Linha 718:
|
|
|}
|}
−Turma:
+==== Turma: ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
Linha 713:
Linha 726:
|Tamanho
|Tamanho
|-
|-
−|'''codigoUnidade'''
+|codigoUnidade
|Código da unidade de ensino que o curso pertence.
|Código da unidade de ensino que o curso pertence.
|Número
|Número
|
|
|-
|-
−|'''periodoLeletivo'''
+|periodoLeletivo
|Descrição do período Letivo atual
|Descrição do período Letivo atual
|Texto
|Texto
|20
|20
|-
|-
−|'''sigla'''
+|sigla
|Código do curso
|Código do curso
|Texto
|Texto
|15
|15
|-
|-
−|'''nomeCurso'''
+|nomeCurso
|Nome do curso
|Nome do curso
|Texto
|Texto
|70
|70
+|-
+|numeroSerieDeMatricula
+|Numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha
+|Número
+|
+|-
+|nomeSerie
+|Nome da série
+|Texto
+|70
+|-
+|nomeTurma
+|Nome da turma
+|Texto
+|65
|}
|}
