Páginas filhas
  • Manual Operacional da Customização - Integração SENAI APP - FS007525

Manual Operacional da Customização - Integração SENAI APP - FS007525


Projeto: FS007525 – Integração Senai APP
Cliente: SENAI DN


Objetivo deste documento


Prezados Senhores,

O documento a seguir tem por objetivo orientar o usuário sobre as implementações realizadas para sua empresa. Todas as funcionalidades descritas neste manual têm como base o que está descrito no documento FS007523 - Integração Itinerário.

Síntese


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.


Requisitos


Pré-Requisitos / Parametrizações

Não se aplica.

Detalhamento do Processo

O 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:

Parâmetro

Tipo

Observação

token

String

Código Hash gerado pela TOTVS

cpfProfessor

String

CPF do professor


 Se houver algum erro, o WebService irá retornar uma mensagem de erro e será finalizado.


Exemplo de mensagem com erro:

{

  "sucesso": "0",

  "mensagem": "Erro ao buscar Turmas do Professor 'Professor Senai 01': Usuário não autenticado.",

  "turmas":[]

}

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:

{

  "sucesso": "1",

  "mensagem": "Registros recuperados com sucesso!",

  "turmas":

  [

    {

      "descMatrizCurricular": "Técnico em Celulose e Papel",

      "codTurma": "TEC-P-000208/2016",

      "nomeTurma": "TCP - SISUTEC - SUB 1 4º",

      "idTurmaDisc": "37362",

      "codDisc": "TEC.036.0001",

      "descDisc": "Acabamento e Conversão",

      "dtInicioTurmaDisc": "2016-05-25 00:00:00.000",

      "dtFimTurmaDisc": "2016-07-05 00:00:00.000"

    },

    {

      "descMatrizCurricular": "Técnico em Celulose e Papel",

      "codTurma": "TEC-P-000209/2016",

      "nomeTurma": "TCP - PRONATEC 5",

      "idTurmaDisc": "37368",

      "codDisc": "TEC.036.0001",

      "descDisc": "Acabamento e Conversão",

      "dtInicioTurmaDisc": "2016-05-01 00:00:00.000",

      "dtFimTurmaDisc": "2016-06-05 00:00:00.000"

    },

    {

      "descMatrizCurricular": "Técnico em Celulose e Papel",

      "codTurma": "TEC-N-000202/2016",

      "nomeTurma": "Celulose e Papel PISA/STORA",

      "idTurmaDisc": "35960",

      "codDisc": "TEC.036.0001",

      "descDisc": "Acabamento e Conversão",

      "dtInicioTurmaDisc": "2016-02-11 00:00:00.000",

      "dtFimTurmaDisc": "2016-07-07 00:00:00.000"

    }

  ]

}



Pré-Requisitos / Parametrizações

Nenhum.


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:

Parâmetro

Tipo

Observação

token

String

Código Hash gerado pelo TOTVS

idTurmaDisc

Int

Identificador da turma/disciplina


Se houver erro, o WebService irá retornar uma mensagem de erro e será finalizado.


Exemplo de mensagem com erro:

{

  "sucesso": "0",

  "mensagem": "Erro ao buscar alunos da Turma 'TEC-P-000208/2016' do Professor 'Professor Senai 01': Usuário não autenticado.",

  "alunosTurma":[]

}


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:

{

  "sucesso": "1",

  "mensagem": "Registros recuperados com sucesso!",

  "alunosTurma":[    {

      "raAluno": "13740",

      "nomeAluno": "Aluno 13740",

      "dtNascAluno": "1996-10-02 00:00:00.000",

      "sexoAluno": "F",

      "corRacaAluno": "Parda",

      "tipoDeficiencia": "",

      "emailAluno": "aluno13740@gmail.com",

      "cepAluno": "85960-123",

      "celAluno": "(45)9999-8888",

      "cpfAluno": "08884398573",

      "rgAluno": "mg15102821"

    },

    {

      "raAluno": "28105",

      "nomeAluno": "Aluno 28105",

      "dtNascAluno": "1999-07-31 00:00:00.000",

      "sexoAluno": "M",

      "corRacaAluno": "Branca",

      "tipoDeficiencia": "Auditiva",

      "emailAluno": "aluno28105@hotmail.com",

      "cepAluno": "85960-321",    

      "celAluno": "(45)9999-7777",

      "cpfAluno": "09928517936",

      "rgAluno": "mg15102821"

     }

  ]

}


Histórico de atualização do documento

Histórico de versões

Data

Autor

Versão

Descrição das alterações

11/05/2016

Renato Barbosa de Paula

1.0

Criação do manual

08/05/2018Adilson José de Aquino2.0Alterações.
09/10/2018Thiago Neiva Chagas3.0Importação manual para o TDN.