Histórico da Página
...
Este documento tem como objetivo exemplificar a forma de utilização da API de preenchimento da ficha médica do candidaton o candidato no TOTVS Processo Seletivo.
Esta API possibilita incluir, atualizar ou acessar a ficha médica do candidato do TOTVS Processo Seletivo.
É importante importante ressaltar que neste modelo o aplicativo RM.Host é responsável por hospedar e expor os serviços de APIs. Veja mais sobre a configuração clicando aqui.
Recurso disponível a partir da versão 12.1.2402.
Pré-requisitos
...
- Permissão
Por questão de segurança e rastreabilidade, as requisições serão permitidas somente para um usuários usuário cadastrado no RM, portanto é necessário conceder as devidas permissões apara o perfil do usuário que irá executar as requisições.
...
O TOTVS Processo Seletivo irá considerar as parametrizações referente referentes ao termo de consentimento de uso de imagem e voz que foram definidas no no TOTVS Educacional, para maiores informações clique aqui.
- No TOTVS Processo Seletivo
(Este item tem que ser revisto ao cria a o preenchimento da ficha pela central do candidato)
...
- , é necessário indicar que a utilização da ficha médica está habilitada para o processo seletivo. A configuração deve ser realizada em "Edição de Processo Seletivo" > Parâmetros > Matrícula > Confirmação Matrícula > Utiliza ficha médica flexível. Para maiores informações acesse Parâmetro - Matrícula.
Caso o parâmetro não esteja marcado, as chamadas para as APIs da ficha médica GET, POST e PUT, devem ter as seguintes informações no seu retorno:
Dicas
...
A construção do modelo da ficha médica que será utilizada é realizada no TOTVS Educacional, no TOTVS Educacional será possível permitido definir um único modelo ativo por contexto, ou seja, o modelo que estiver ativo naquele contexto será o modelo disponibilizado para preenchimento em todo o RM (Portal do aluno, Portal Gestão Educacional ou Portal do TOTVS Processo Seletivo).
...
Dica | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Para ter acesso a estrutura do modelo ativo e que será será utilizado pela API de preenchimento da ficha médica, orientamos consumir a API abaixo: Máscara de Url: http://{domínio}:{porta}/api/educational/v1/medicalrecord/templates/{Id. Modelo}?Expand=wrapper,section,field Exemplo de configuração: Domínio: localhost Porta: 8051 Expand=wrapper,section,field: indica que a requisição ira retornar os agrupadores, seções e campos. Id. Modelo: Identificador do modelo da ficha médica que deseja recuperar, se passar -1 será retornado o modelo que esta ativoestá ativo no contexto. Url Utilizada: http://localhost:8051/api/educational/v1/medicalrecord/templates/-19?Expand=wrapper,section,field
|
...
- GET ( Retorna a ficha médica cadastrada)
- POST (Criar Cria nova ficha médica)
- PUT (Atualiza informações da ficha médica)
...
Informações | |||||
---|---|---|---|---|---|
| |||||
Domínio: localhost Porta: 8051 Cód. Coligada: 1, Id. Processo Seletivo: 161, Cód. Usuário PS: 386, Id. Ficha Médica:-1, Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pela atualização:26
|
Expandir | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Caso o usuário não possua nenhum ficha médica cadastrada (para o modelo ativo no RM) será retorno um objeto vazio conforme o exemplo abaixo:
|
|
Expandir | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Caso o usuário não possua nenhum ficha médica cadastrada (para o modelo ativo no RM) será retorno um objeto vazio conforme o exemplo abaixo: idMedicalRecord: -1 = Indica que deverá ser incluída uma nova ficha médica. idModel = Sempre retorna o id. modelo que esta ativo no TOTVS Educacional.
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
| ||||||||||||||||
Expandir | ||||||||||||||||
| ||||||||||||||||
|
1.2 - POST (Criar uma nova ficha médica)
|
1.2 - POST (Criar uma nova ficha médica)
...
Máscara de Url:http://{domínio}:{porta}/api/educational/v1/ApplicantRegistries/{Cód. da Coligada}|{Id. Processo Seletivo}Máscara de Url:http://{domínio}:{porta}/api/educational/v1/ApplicantRegistries/{Cód. da Coligada}|{Id. Processo Seletivo}|{Cód. Usuário PS }/medicalRecord/{Id. Ficha Médica}?BranchCode={Cód Filial}&LevelEducationCode={Nível de ensino}&ResponsibleApplicantCode={Cód. Usuário PS responsável pela operação}
Informações | ||||
---|---|---|---|---|
| ||||
Domínio: localhost Porta: 8051 Cód. Coligada: 1, Id. Processo Seletivo: 161, Cód. Usuário PS: 386, Id. Ficha Médica:42, Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pela atualização:26 Url Url Utilizada: http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|386/medicalRecord/42?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26 |
Informações | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
...
Máscara de Url:http://{domínio}:{porta}/api/educational/v1/ApplicantRegistries/{Cód. da Coligada}|{Id. Processo Seletivo}|{Cód. Usuário PS }/termUseOfImageVoicemedicalRecord/{GUIDId. Ficha Médica}?BranchCode={Cód Filial}&LevelEducationCode={Nível de ensino}&ResponsibleApplicantCode={Cód. Usuário PS responsável pelo aceite/revogação}
Nota |
---|
GUID: Este é o GUID que representa o identificador único do termo que foi retornado na requisição GET. |
pela operação}
Informações | ||||
---|---|---|---|---|
| ||||
Domínio: localhost Porta: 8051 Cód. Coligada: 1, Id. Processo Seletivo: 161, Cód. Usuário PS: 83, GUID:d3c4a091-ea4c-474a-900f-f2ecd970520e386, Id. Ficha Médica:48, Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pelo Aceite/Revogaçãopela atualização:26. Url Utilizada: http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|83386/termUseOfImageVoice/d3c4a091-ea4c-474a-900f-f2ecd970520e?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26medicalRecord/48 |
Informações | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Informações | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| O resultado é basicamente o mesmo resultado da requisição GET acrescido de algumas informações complementares, tais como: data/hora do aceite ou revogação.|||||||||||||||||||||
|
Informações | ||
---|---|---|
| ||
Ao realizar o aceite / revogação do termo será encaminhado um e-mail de notificação para instituição conforme as parametrizações definidas no TOTVS Educacional. Para maiores informações clique aqui |
Aviso | ||
---|---|---|
Se o processo seletivo estiver parametrizado para usar o termo de consentimento de uso de imagem e voz, ao realizar a matricula do candidato no TOTVS Educacional será obrigatório existir para o mesmo um termo com o status de aceito ou revogado (isto se o sistema estiver parametrizado para permitir que o termo seja revogado).
|