Páginas filhas
  • 05 - API Aceite / Revogação do termo de consentimento de uso de imagem e voz do TOTVS Processo Seletivo.

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Sumário

...

Índice
excludeSumário

Objetivo

...

Este documento tem como objetivo exemplificar a forma de utilização da API de aceite / revogação do termo de consentimento de uso de imagem e voz para o 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

...

  • Permissão

Por questão de segurança e rastreabilidade as requisições serão permitidas somente usuários cadastrado no RM, portanto é necessário habilitar para o perfil do usuário que irá executar as requisições as devidas permissões.

...

É necessário indicar que a utilização do termo esta habilitada para o processo seletivo. Para maiores informações acesse Parâmetro - Matrícula.

1 - Métodos

...

      Serão apresentados 3 métodos, os quais foram implementados na API do Termo, são eles:

  • GET ( Retorna o termo do candidato)
  • POST (Enviar token)
  • PUT (Aceite / revogação)

1.1 - GET (Recuperar / Gerar termo)

...

Máscara de Url: http://{domínio}:{porta}/api/educational/v1/ApplicantRegistries/{Cód. da Coligada}|{Id. Processo Seletivo}|{Cód. Usuário PS }/termUseOfImageVoice/-1?BranchCode={Cód Filial}&LevelEducationCode={Nível de ensino}&ResponsibleApplicantCode={Cód. Usuário PS responsável pelo aceite/revogação}

...

Nota

Se um candidato já possuir um termo com status igual a "Aceito" ou "Revogado" e a instituição alterar a versão do termo, ao realizar uma nova requisição o TOTVS Processo Seletivo identificara que houve alteração na versão e irá gerar um novo termo com status "Pendente" para que seja realizado um novo "Aceite" ou "Revogação".

1.2 - POST (Token)

...

Quando o TOTVS Educacional estiver parametrizado para utilizar token de segurança (mais informações clique aqui) , será necessário executar esta requisição para que o token seja enviado para o e-mail do usuário do responsavel pela execução do aceite / revogação.

...

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "guid": "d3c4a091-ea4c-474a-900f-f2ecd970520e",
    "companyCode": "1",
    "branchCode": "1",
    "personCode": "19",
    "levelEducationCode": "1",
    "emailSentToken": "da****.al***@to***.com.br",
    "enableOnlyAccept": "N"
}
Informações

Posteriormente quando for executar a requisição PUT(Aceite ou Revogação) deverá ser informado o token enviado para o e-mail do usuário responsável. 

1.3 - PUT (Aceite / Revogação)

...

Máscara de Url: http://{domínio}:{porta}/api/educational/v1/ApplicantRegistries/{Cód. da Coligada}|{Id. Processo Seletivo}|{Cód. Usuário PS }/termUseOfImageVoice/{GUID}?BranchCode={Cód Filial}&LevelEducationCode={Nível de ensino}&ResponsibleApplicantCode={Cód. Usuário PS responsável pelo aceite/revogação}

...