Comparação de Páginas

...

Informações
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/locaisAtendimento

note

Atenção

O endpoint obrigatoriamente deve terminar com “/aps/locaisAtendimento

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

IdTipoAtividade


idTipoAtividade	OP	Number	ID do tipo de atividade

cadastrado pela

cadastrado pelo PREVIVA
dataReferencia	OP	String
IdTipoAtendimento	OP	Number	ID do tipo de atendimento cadastrado pelo PREVIVA	ID do tipo de

atividade

atendimento selecionado na etapa de seleção de tipo de consulta.

Identifica o tipo de consulta:

Presencial
teleconsulta

idRegiao

OP

Number

ID da região cadastrado pelo previva.

Bloco de código

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    },
    "dataReferencia": "String"
    "idAtividade:": "Number",
    "idTipoAtividade": "Number"
    "idTipoAtendimento": "Number",
    "idRegiao": "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

Bloco de código
{ "beneficiario":{ "chaveUnica":"String", "numeroContrato":"String", "integracao":{ Objeto } }

...

Bloco de código

{
  "chaveUnica": "101012",
  "integracao": {
    "cpf": "123456789123",
    "numero_cartao": "9288701",
  },
  "beneficiario": {
    "chaveUnica": "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "integracao": {
        "cpf": "123456789123", 
        "numero_cartao": "9288701",
      },
  },
  "dataReferencia":"2024/05/16",
  "idAtividade":123,  
  "idRegiao":123,
  "idTipoAtendimentoidTipoAtividade": 123,
  "idTipoAtividadeidTipoAtendimento": 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
locais	M	Array de objetos do tipo "locais"
alerta	OP	String	Texto de alerta geral dos locais de atendimento	Texto Livre

Bloco de código
{ "alerta": "String" "locais": [ "Objeto" ], }

Objeto locais

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricao	M	String	Texto de descrição do local de atendimento	Texto livre
id	M	String	id do local de atendimento
endereco	M	Objeto	Objeto com dados do endereço	Objeto endereço
contatos	M	Array	Array de objetos do tipo contato	Array de objeto contato
alerta	OP	String	Texto de alerta do local de atendimento	Texto Livre
quantidadeMedicos	OP	String	Quantidades de médicos disponíveis para atendimento

Bloco de código
{ "locais":[ { "descricao":"String", "id":"String", "alerta":"String", "endereco":{ objeto }, "contatos": [ Array-objetos ], "quantidadeMedicos": "String" }

Objeto endereco

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
endereco	M	String	Texto de endereço do local de atendimento	Texto livre
numero	M	String	Número do local de atendimento	Texto livre
complemento	M	String	Complemento do local de atendimento	Texto livre
bairro	M	String	Bairro do local de atendimento	Texto livre
cidade	M	String	Cidade do local de atendimento	Texto livre
estado	M	String	Estado do local de atendimento	Texto livre

Bloco de código
{ "locais":[ { "endereco":{ "endereco":"String", "numero":"String", "complemento":"String", "bairro":"String", "cidade":"String", "estado":"String" } }

Objeto contato

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
tipo	M	String	Tipo de contato	Conteúdo válido: 1 = Telefone 2 = Email
id	M	String	id do contato
titulo	M	String	Titulo do contato	EX: “Telefone"
valor	M	String	Valor do contato	EX:”28 999999999"

Bloco de código
{ "locais":[ { "contatos": [ { "tipo":"String", "titulo":"String", "valor":"String" } ] }

...

Retorno da API - Sucesso

Bloco de código

language	json

{
    "alertaPrincipal":"Atenção: agendamentos só podem ser feitos com um máximo de 90 dias.",
    "locais":[
      {
        "descricao":"Hospital Sirio Libanes",
        "id":"19920",
        "alerta":"Atenção: Reforçamos medidas para o seu cuidado, como controle e monitoramento de temperatura das pessoas que circulam nas unidades, fluxos de atendimento, espaços físicos e equipes diferentes para pacientes com e sem sintomas de doenças respiratórias, horário mais espaçado entre as consultas (para evitar aglomerações).",
        "endereco":{
          "endereco":"Rua Dona Adma Jafet",
          "numero":"91",
          "complemento":"apt 414",
          "bairro":"Bela Vista",
          "cidade":"São Paulo",
          "estado":"SP"
        },
        "contatos":[
          {
            "tipo":"1",
            "titulo":"Telefone",
            "valor":"27 99292-9292"
          },
          {
            "tipo":"2",
            "titulo":"E-mail",
            "valor":"siriolibanes@hospital.com"
          }
        ]
      }
    ]
  }

Retorno da API - Falha

json

Bloco de código
language

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

...

Versões comparadas

Versão antiga 8

Nova versão 9

Chave

Endpoint

Parâmetros de entrada

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

Retorno da API - Sucesso

Retorno da API - Falha