Lista de tipos de atividades

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/atividades/tipoAtividades"

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/atividades/tipoAtividades Atenção O endpoint obrigatoriamente deve terminar com “/aps/tipoAtividades	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
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	M	Number	ID da atividade cadastrada pelo PREVIVA

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

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":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
atividades	M	Array de objetos do tipo "tipos de atividade"

{
  "tipoAtividades": [ "Objeto" ],
}

Objeto "tipo atividade"

Atributo	Critério	Tipo	Descrição
codigo	M	Numer	Codigo identificador do subgrupo
titulo	M	String	Titulo do subgrupo
descricao	OP	String	Descrição do subgrupo
icone	OP	String	Icone do subgrupo

Retorno da API - Sucesso

{
    "tipoAtividades":[
      {
        "codigoTipoAtividade": 123,
        "titulo": "Consulta Presencial",
        "descricao":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eget ligula eu lectus lobortis condimentum.",
      },
      {
        "codigoTipoAtividade": 123,
        "titulo": "Consulta Presencial",
        "descricao":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eget ligula eu lectus lobortis condimentum.",
      },
      {
        "codigoTipoAtividade": 123,
        "titulo": "Consulta Presencial",
        "descricao":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eget ligula eu lectus lobortis condimentum.",
      },
    ]
  }

Retorno da API - Falha

{
  "mensagem": "Não foi possível listar suas atividades"
}

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;