Inscrição curso

Só são suportadas integrações no padrão REST.

Introdução

Método de listagem dos indicadores favoritos do paciente

Método "aps/atividade/realizaAtividade"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição
exemplo.com / aps/curso/inscricao	POST	application/json

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição	Regra de preenchimento
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	Nó integração retornado no login do usuário
beneficiario	M	Objeto	Beneficiario selecionado para agendamento da consulta
idAtividade	C	String	Código identificador da atividade	Obrigatorio quando for atraves da realizacao de uma atividade
idAtendimento	C	String	Código identificador do atendimento	Obrigatorio quando for atraves da realizacao de uma atividade
idCurso	M	String	Código identificador do tipo de atendimento
idTurma	M	String	Código identificador do questionario cadastrado no previva

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    "idAtividade": "String",
    "idAtendimento": "String",
    "idTurma": "String",
    "idCurso": "String"
}

Objeto beneficiario

Atributo	Critério	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do paciente
numeroContrato	M	String	Número do contrato do paciente
integracao	OP	Objeto	Nó integração retornado no login do usuário

{
    "beneficiario":{
      "chaveUnica":"String",
      "numeroContrato":"String",
      "integracao":{ Objeto }
}

Exemplo request

{
  "chaveUnica": "101012",
  "integracao": {
    "cpf": "123456789123",
    "numero_cartao": "9288701",
  },
  "beneficiario": {
    "chaveUnica": "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "integracao": {
        "cpf": "123456789123", 
        "numero_cartao": "9288701",
      },
    },
    "idAtividade":"39",
    "idAtendimento":"39",
    "idTurma":"39",
    "idCurso": "1",     
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
protocolo	M	String	Numero de protocolo gerado pelo sistema da PREVIVA.
mensagem	M	String	Mensagem amigável que será exibida para o usuário

{
  "protocolo": "String",
  "mensagem": "String",
}

Retorno da API - Sucesso

{
  "protocolo": "123",
  "mensagem": "Sucesso!"
}

Retorno da API - Falha

{
  "mensagem": "Não foi possível registrar a sua inscrição..."
}

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;