Histórico da Página
Sumário
...
Índice |
---|
...
...
|
...
|
Objetivo
...
Este documento tem como objetivo exemplificar a forma de utilização da API de preenchimento da ficha médica do candidato no TOTVS Processo Seletivo.
Esta API possibilita incluir, atualizar ou acessar a ficha médica do candidato do TOTVS Processo Seletivo.
É 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ário cadastrado no RM, portanto é necessário conceder as devidas permissões apara o perfil do usuário que irá executar as requisições.
- Parâmetros
O TOTVS Processo Seletivo irá considerar as parametrizações referentes ao termo de consentimento de uso de imagem e voz que foram definidas no TOTVS Educacional, para maiores informações clique aqui.
- No TOTVS Processo Seletivo, é 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á 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).
Para conhecer mais sobre a criação de modelos clique aqui.
Dica | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Para ter acesso a estrutura do modelo ativo e que 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 está ativo no contexto. Url Utilizada: http://localhost:8051/api/educational/v1/medicalrecord/templates/9?Expand=wrapper,section,field
| ||||||||||||||||
title | Exemplo de Resultado |
Sumário
ObjetivoEste documento tem como objetivo exemplificar a forma de utilização da API de preenchimento da ficha médica do candidaton o 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. Pré-requisitos
Por questão de segurança e rastreabilidade as requisições serão permitidas somente para um usuários 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 ao termo de consentimento de uso de imagem e voz que foram definidas no TOTVS Educacional, para maiores informações clique aqui.
(Este item tem que ser revisto ao cria a o preenchimento da ficha pela central do candidato) É necessário indicar que a utilização do termo esta habilitada para o processo seletivo. Para maiores informações acesse Parâmetro - Matrícula. DicasA 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). Para conhecer mais sobre a criação de modelos clique aqui.
1 - MétodosSerão apresentados 3 métodos, os quais foram implementados na API do Termo, são eles:
1.1 - GET (Retorna a ficha médica cadastrada)
|
1 - Métodos
...
Serão apresentados 3 métodos, os quais foram implementados na API do Termo, são eles:
- GET ( Retorna a ficha médica cadastrada)
- POST (Cria nova ficha médica)
- PUT (Atualiza informações da ficha médica)
1.1 - GET (Retorna a ficha médica cadastrada)
...
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:-1, Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pela atualização:26 Url Utilizada: http://localhost:8051Má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}1|161|386/medicalRecord/-1?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=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: 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 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
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}|{Cód. Usuário PS }/medicalRecord/?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, Cód. Filial: 1, Nível de Ensino:1: 1, Id. Processo Seletivo: 161, Cód. Usuário PS Responsável pela atualização: 26386 Url Utilizada: http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|386/medicalRecord/ ?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26 |
Informações | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Informações | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
1.3 - PUT (Atualiza informações da ficha médica)
...
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:48, Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pela atualização:26 Url Utilizada: http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|386/medicalRecord/48 ?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26 |
Informações | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Informações | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
|