Linha RM

Atalhos

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

Versão antiga 18

changes.mady.by.user Darlan Alvysson Alves

Gravado em

comparado com

Nova versão 19

changes.mady.by.user Darlan Alvysson Alves

Gravado em

Chave

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

...

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.

Ao executar a requisição (PUT) deverá ser informado o token enviado para o e-mail do usuário responsavel. 

Máscara de Url:http://{domínio}:{porta}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}/token?BranchCode={Cód Filial}&LevelEducationCode={Nível de ensino}&ResponsibleApplicantCode={Cód. Usuário PS responsável pelo aceite/revogação}

...

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Cód. Coligada: 1,  Id. Processo Seletivo: 161, Cód. Usuário PS: 83, GUID:d3c4a091-ea4c-474a-900f-f2ecd970520e,Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pelo Aceite/Revogação:26.

Url Utilizada:http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|83/termUseOfImageVoice/d3c4a091-ea4c-474a-900f-f2ecd970520e/token?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26

Informações
iconfalse
titleExemplo de EntradaResultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "ConsentStatusguid":"A "d3c4a091-ea4c-474a-900f-f2ecd970520e",
    "SourceIPcompanyCode": "192.168.18.1",
   "Token" :"335554"
}
Informações
iconfalse
titleExemplo de Resultado

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.

Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{ "branchCode": "1",
    "personCode": "19",
    "levelEducationCode": "1",
    "guidemailSentToken": "d3c4a091-ea4c-474a-900f-f2ecd970520eda****.al***@to***.com.br",
    "companyCodeenableOnlyAccept": "1N",
    "branchCode": "1",
    "personCode": "19",
    "levelEducationCode": "1",
    "dateTimeRevoked": "2023-08-28T09:22:39.0001701-03:00",
    "dateTimeAccepted": "2023-08-22T11:47:08-03:00",
    "userHasPermissionAcceptedOrRevoked": true,
    "token": "858371",
    "consentStatus": "A",
    "termVersion": 5,
    "term": "",
    "enableOnlyAccept": "N"
}
Informações

Se o candidato for menor de idade, somente será permitido aceite ou revogação para o responsável parametrizado no TOTVS Educacional, sendo permitido parametrizar para que o próprio aluno/candidato menor de idade também execute o aceite/revogação.

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).

Informações
titleNotificação

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 

1.3 - 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.

Ao executar a requisição (PUT) deverá ser informado o token enviado para o e-mail do usuário responsavel. 

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}/token?BranchCode={Cód Filial}&LevelEducationCode={Nível de ensino}&ResponsibleApplicantCode={Cód. Usuário PS responsável pelo aceite/revogação}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Cód. Coligada: 1,  Id. Processo Seletivo: 161, Cód. Usuário PS: 83, GUID:d3c4a091-ea4c-474a-900f-f2ecd970520e,Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pelo Aceite/Revogação:26.

Url Utilizada:http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|83/termUseOfImageVoice/d3c4a091-ea4c-474a-900f-f2ecd970520e/token?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26


}

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}

Nota

GUID: Este é o GUID que representa o identificador único do termo que foi retornado na requisição GET.

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Cód. Coligada: 1,  Id. Processo Seletivo: 161, Cód. Usuário PS: 83, GUID:d3c4a091-ea4c-474a-900f-f2ecd970520e,Cód. Filial: 1, Nível de Ensino:1, Cód. Usuário PS Responsável pelo Aceite/Revogação:26.

Url Utilizada: http://localhost:8051/api/educational/v1/ApplicantRegistries/1|161|83/termUseOfImageVoice/d3c4a091-ea4c-474a-900f-f2ecd970520e?BranchCode=1&LevelEducationCode=1&ResponsibleApplicantCode=26

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
   "ConsentStatus":"A",
   "SourceIP":"192.168.18.1",
   "Token" :"335554"
}
Informações
iconfalse
titleExemplo de Resultado

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.

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",
    "dateTimeRevoked": "2023-08-28T09:22:39.0001701-03:00",
    "dateTimeAccepted": "2023-08-22T11:47:08-03:00",
    "userHasPermissionAcceptedOrRevoked": true,
    "token": "858371",
    "consentStatus": "A",
    "termVersion": 5,
    "term": "",
    "enableOnlyAccept": "N"
}
Informações

Se o candidato for menor de idade, somente será permitido aceite ou revogação para o responsável parametrizado no TOTVS Educacional, sendo permitido parametrizar para que o próprio aluno/candidato menor de idade também execute o aceite/revogação.

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).

{ "guid": "d3c4a091-ea4c-474a-900f-f2ecd970520e", "companyCode": "1", "branchCode": "1", "personCode": "19", "levelEducationCode": "1", "emailSentToken": "da****.al***@to***.com.br", "enableOnlyAccept": "N" }

Informações
titleNotificação

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 

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue