...
O objetivo desta customização é prover o recurso de Web Service para que a aplicação SENAI APP possa ser integrada com o TOTVS SGE de forma que o Professor, a partir do SENAI APP, tenha condições de recuperar no TOTVS SGE as turmas/disciplinas que atuará no período e os alunos matriculados na turma/disciplina.
Expandir | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Pré-Requisitos / ParametrizaçõesNão se aplica. Detalhamento do ProcessoO WebService receberá como parâmetro o Token de acesso ao serviço e CPF do professor. O WebService irá recuperar o professor referente ao CPF passado como parâmetro. Se não existir professor para o CPF informado, será retornada a mensagem de erro “Não existe no SGE professor cadastrado para o CPF informado”. Uma vez recuperado os dados do professor, o WebService irá filtrar na tabela de turma do professor as turmas/disciplinas ativas e vigentes na data atual vinculadas ao professor. Se não existir turma/disciplina ativa e vigente para o professor, será retornada a mensagem de erro “Não existe no SGE turma/disciplina ativa e vigente para o professor.”. GetTurmasDisciplinasProfessor Assinatura do serviço: public TurmaRetornoCxt GetTurmaDisciplinasProfessor(string token, string cpfProfessor); URI de acesso ao serviço: http://{url ou ip servidor webservice}/sge/services/turma/{ valor do token}/{cpf do Professor} sge: Nome do site criado no IIS Exemplo: http://SRVTESTE/MundoSenaiAPP/services/turma/2349032rer4fk5js3/11122233344 Parâmetro(s) de entrada:
Se houver algum erro, o WebService irá retornar uma mensagem de erro e será finalizado. Exemplo de mensagem com erro:
Se autenticado, o WebService irá realizar a consulta na base de dados do TOTVS Educacional e retornar as turmas/disciplinas do professor passado como parâmetro. O retorno será no formato JSON.
Exemplo de mensagem com sucesso:
|
Expandir | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Pré-Requisitos / ParametrizaçõesNenhum. Detalhamento do Processo O WebService receberá como parâmetro o Token de acesso ao serviço e identificador da turma/disciplina. O WebService irá filtrar os alunos matriculados na turma/disciplina passada como parâmetro.Serão considerados como matriculados na turma/disciplina apenas os alunos cuja situação de matrícula esteja com a flag ‘É uma disciplina em curso’ marcada. Se não existir aluno matriculado na turma/disciplina, será retornada a mensagem de erro “Não existe no SGE aluno matriculado na turma/disciplina.”. getAlunosTurmaDisciplina Assinatura do serviço: public AlunoRetornoCxt GetAlunosTurmaDisciplina(string token, string idTurmaDisc) URI de acesso ao serviço: http://{url ou ip servidor webservice}/sge/services/aluno/{ valor do token}/{idTurmaDisc} sge: Nome do site criado no IIS Exemplo: http://SRVTESTE/MundoSenaiAPP/services/aluno/2349032rer4fk5js3/2022 Parâmetro(s) de entrada:
Se houver erro, o WebService irá retornar uma mensagem de erro e será finalizado. Exemplo de mensagem com erro:
Se a requisição for realizada com sucesso, o WebService irá realizar a consulta na base de dados do TOTVS Educacional e retornar os alunos matriculados da turma/disciplina passada como parâmetro. O retorno será no formato JSON.
Exemplo de mensagem com sucesso:
|
...