Detalhe da turma

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

Introdução

Método de listagem de atividades do programa de APS

Método "aps/curso/turma/detalhe"

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

Endpoint	Método	Header Content-Type	Descrição
exemplo.com / aps/curso/turma	POST	application/json	Endpoint responsavel por realizar a adesão no programa de APS

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

Parâmetro	Obrigatório	Tipo	Descrição
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
idCurso	OP	Number	ID do curso cadastrado pela PREVIVA

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    },
    "idTurma:": Number,
}

Objeto beneficiario

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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",
      },
  },
  "idTurma":123,
}

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigoTurma	M	Numer	Codigo identificador da turma cadastrada no Previva
titulo	M	Number	titulo da turma
dataInicio	M	String	data de inicio do curso	Formato esperado: `YYYY-MM-DD HH:mm:ss`
quantidadeMaximaParticipantes	M	Objeto do tipo item
curso	M	Objeto	Objeto do tipo “curso"	classificação do tipo de atendimento
dataInscricao	OP	String	data em que o beneficiario se inscreveu no curso	Formato esperado: `YYYY-MM-DD HH:mm:ss`
dataCancelamento	OP	String	data em que o beneficiario cancelou o curso	Formato esperado: `YYYY-MM-DD HH:mm:ss`
dataConclusao	OP	String	data em que o beneficiario concluiu o curso	Formato esperado: `YYYY-MM-DD HH:mm:ss`
situação	OP	Objeto do tipo item	situacao do beneficiario no curso
quantidadeParticipantes	OP	String	Quantidade de participantes inscritos na tu
quantidadeEncontrosDisponiveis	OP	String	Data na qual a atividade foi realizada

Objeto "curso"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
titulo	M	String	Titulo do curso
descricao	M	String	Descrição do curso
cargaHorariaEmHoras	M	Number

Objeto “item"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	Numer	Codigo identificador do item
descricao	M	String	Descrição do item

Retorno da API - Sucesso

Retorno da API - Falha

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;