Comparação de Páginas

...

Endpoint

Método

Header Content-Type

Descrição

exemplo.com / aps/locaisAtendimentogravarConsulta

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/aps/gravarConsulta

POST

application/json

Parâmetros de entrada

...

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
idLocal	OP	String	Id do local da consulta	Obrigatório quando agendamento presencial
IdTipoAtendimentoIdTipoAtividade	MOP	Number	ID do tipo de atendimento retornado no payload do endpoint de: Lista de agendas dos profissionais	idProfissional	OP	String	idAgenda	M	String	id da agenda	atividade cadastrado pela PREVIVA	ID do tipo de atividade selecionado na etapa de seleção de tipo de consulta. Identifica o tipo de consulta: Presencial teleconsulta
IdTipoAtendimento	OP	Number	ID do tipo de atendimento selecionado na tela de seleção de tipo de atendimento
idProfissional	OP	String	Quando enviado deve retornar dados do detalhe da agenda do profissional. O array de profissionais deve conter somente um profissional
idAgenda	M	String	id da agenda
dataHora	M	String	Data e hora disponível	Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss
dadosContato	OP	Objeto	Objeto com dados do contato referente ao formulário de contato
idMeeting	C	String	idMeeting fornecido pela Mobile Saúde para agendamentos do tipo teleconsulta.	Este parâmetro será enviado em casos de agendamento do tipo teleconsulta.

...

Bloco de código

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    },
    "idAtividade:": Number,
    "idTipoAtendimentoidTipoAtividade": Number,
    "idLocalidTipoAtendimento": Number,
    "idProfissionalidLocal": Number,
    "idAgendaidProfissional": Number,
    "dataHoraidAgenda": Number,
    "dataHora":"YYYY-MM-DD hh:mm:ss",
    "dadosContato:":{ Objeto },
    "idMeeting": "String"
}

...

Exemplo request

Bloco de código

{
 
  "idAtividadechaveUnica": "908101012",
 
  "idLocalintegracao": "1",{
    "idProfissionalcpf": "95123456789123",
    "idTipoAtendimentonumero_cartao": "89288701",
  },
  "dataHorabeneficiario": "2024-05-08 17:35",{
    "idAgendachaveUnica":"2024-05-08 17:35",
    "dadosContato": {
    "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "nomeintegracao":"Nome do contato", {
        "celularcpf": "27992293372123456789123", 
        "emailnumero_cartao": "everson@mobilesaude.com.br9288701",
      },
  },
  "idMettingidAtividade": "123"123,  
  "chaveUnicaidRegiao":123,
  "34261753987idProfissional",
  "idTipoAtendimento": 123,
  "integracaoidTipoAtividade":123,
{  "idLocal": 1,
  "idAgenda": 1,
  "cpfdataHora": "34261753987"2024-05-16 14:20:00",
  "dadosContato:":{
      "numero_cartaonome": "01000160600"Nome     }do contato",
    "beneficiario": {
        "chaveUnicacelular": "34261753987289999999999",
 
      "numeroContratoemail": "907337email@teste.com",
     },
  "integracaoidMeeting": {
            "cpf": "34261753987",
            "numero_cartao": "01000160600"
        }
    }
}

"6422f5253333f63b0e9e183f" 
}

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

paciente

profissionaisAgendas

M

Objeto

Objeto com dados do paciente

Array

Array de objetos de dataProfissionais

profissional

M

Objeto profissional

Objeto com dados do profissional

agenda

M

Objeto agenda

Objeto com dados da agenda

numeroProtocolo

M

String

Numero do protocolo gerado pelo agendamento

Bloco de código
{ "profissionaisAgendas": [ Array-Objetos ] }

Objeto dataProfissionais

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

data

M

String

Data da agenda

Deve conter o seguinte formato

Formato: YYYY-MM-DD

profissionais

M

Array

Array de objeto profissional

Bloco de código
{ "numeroProtocoloprofissionaisAgendas":"String", "paciente":{ Objeto }, [ "profissional":{ Objeto } }, "agenda":{ Objeto }"data": "YYYY-MM-DD", "profissionais": [ Array-objetos ] } ] }

Objeto pacienteprofissional

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
nome	M	String	Nome do

pacientechaveUnica

profissional	Texto livre
id	M	String

Chave unica

id do

paciente

profissional

telefone

M

urlFoto

OP

String

Telefone do paciente

Bloco de código
{ "paciente":{ "chaveUnica":"String", "nome":"String", "telefone":"String" } }

Objeto profissional

...

Atributo

...

Obrigatório

...

Tipo

...

Descrição

...

id

...

M

...

String

...

Id do profissional

...

nome

...

M

...

String

...

Telefone do paciente

...

conselho

...

M

...

String

...

Texto de informação do conselho do profissional

...

especialidade

...

M

...

Objeto especialidade

...

Objeto com dados da especialidade do profissional

...

URL da foto do profissional
conselho	M	String	Texto de informação do conselho do profissional	Texto Livre. Ex: "CRM ES 123123"
localAtendimento	M	Objeto	Objeto com dados sobre o local de atendimento	Objeto do tipo localAtendimento
especialidade	M	Objeto	Objeto com dados da especialidade do profissional	Objeto do tipo especialidade
horarios	M	Array	Array de horarios disponíveis para atendimento	Array de objetos horario

Bloco de código
{ "profissionaisAgendas": [ { "idprofissionais":"String", [ "nome { "id": "String", "conselhonome": "String", "especialidade":{ Objeto } "urlFoto": "String", } }

Objeto especialidade

...

Atributo

...

Obrigatório

...

Tipo

...

Descrição

...

id

...

M

...

String

...

Id da especialidade

...

descricao

...

M

...

String

...

Texto de descrição da especialidade

Bloco de código
{ "profissional":{ "conselho": "String", "especialidadelocalAtendimento": { Objeto }, "id":"String", "descricaoespecialidade":"String" } } { Objeto }, "horarios": [ Array-objetos ] } ] } ] }

Objeto agendalocalAtendimento

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

idAgenda

descricao

M

String

id da agenda

dataHora

Data e hora disponível

Deve conter dia e hora.

Formato: YYYY-MM-DD hh:mm:ss

Bloco de código
{ "agenda":{ "idAgenda":"String", "dataHora":"YYYY-MM-DD hh:mm:ss" } }

Retorno da API - Sucesso

...

Texto de descrição do local de atendimento

Texto livre

Ex:”Em atendimento em Local XPTO"

id

M

String

id do local de atendimento

Bloco de código
{ "profissionaisAgendas": [ { "profissionais": [ { "localAtendimento": { "id": "String", "descricao": "String" } } ] } ] }

Objeto especialidade

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Texto de descrição da especialidade

Texto livre

EX:”clinica geral"

id

M

String

id da especialidade

Bloco de código
{ "profissionaisAgendas": [ { "profissionais": [ { "especialidade": { "descricao": "String", "id": "String" } } ] } ] }

Objeto horario

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

idAgenda

M

String

id da agenda

dataHora

Data e hora disponível

Deve conter dia e hora.

Formato: YYYY-MM-DD hh:mm:ss

Bloco de código
{ "profissionaisAgendas": [ { "profissionais": [ { "horarios": [ { "idAgenda": "String", "dataHora": "YYYY-MM-DD hh:mm:ss" } ] } ] } ] }

Retorno da API - Sucesso Caso o atributo data (que é opcional) no body da requisição for preenchido

Bloco de código

{
  "profissionaisAgendas": [
    {
      "data": "2022-03-01",
      "profissionais": [
        {
          "id": "121212",
          "nome": "Dr Joaquim Das Neves",
          "urlFoto": "https://randomuser.me/api/portraits/men/80.jpg",
          "conselho": "CRM-ES 918171",
          "localAtendimento": {
            "id": "x1817",
            "descricao": "Em atendimento em Local Xpxy"
          },
          "especialidade": {
            "descricao": "clinica geral",
            "id": "01928"
          },
          "horarios": [
            {
              "idAgenda": "121212",
              "dataHora": "2022-03-01 11:40:00"
            },
            {
              "idAgenda": "121212",
              "dataHora": "2022-03-01 13:40:00"
            },
            {
              "idAgenda": "121212",
              "dataHora": "2022-03-01 14:40:00"
            }
          ]
        },
        {
          "id": "2",
          "nome": "Dr. Carlos Alberto de Souza",
          "conselho": "CRM-ES 31312312",
          "localAtendimento": {
            "id": "1",
            "descricao": "Atendimento em Hospital São José"
          },
          "especialidade": {
            "id": "1",
            "descricao": "Clínico Geral"
          },
          "horarios": [
            {
              "idAgenda": "1",
              "dataHora": "2022-03-01 11:30:00"
            },
            {
              "idAgenda": "2",
              "dataHora": "2022-03-01 13:00:00"
            },
            {
              "idAgenda": "5",
              "dataHora": "2022-03-01 15:00:00"
            },
            {
              "idAgenda": "6",
              "dataHora": "2022-03-01 16:00:00"
            }
          ]
        }
      ]
    }
  ]
}

Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido

Bloco de código

{
  "profissionaisAgendas":[
      {
        "data":"2022-02-01",
        "profissionais":[]
      },
      {
        "data":"2022-02-03",
        "profissionais":[]
      },
      {
        "data":"2022-02-04",
        "profissionais":[]
      },
      {
        "data":"2022-02-07",
        "profissionais":[
          {
            "id":"1",
            "nome":"Dr. Pedro Paulo Pereira",
            "conselho":"CRM-ES 918171",
            "urlFoto":"https://randomuser.me/api/portraits/men/80.jpg",
            "localAtendimento":{
              "id":"123",
              "descricao":"Hospital São José"
            },
            "especialidade":{
              "id":"9191919",
              "descricao":"Clínico Geral"
            },
            "horarios":[
              {
                "idAgenda":"3",
                "dataHora":"2022-02-07 10:30:00"
              },
              {
                "idAgenda":"4",
                "dataHora":"2022-02-07 11:30:00"
              },
              {
                "idAgenda":"5",
                "dataHora":"2022-02-07 13:00:00"
              },
              {
                "idAgenda":"8",
                "dataHora":"2022-02-07 15:00:00"
              },
              {
                "idAgenda":"9",
                "dataHora":"2022-02-07 16:00:00"
              },
              {
                "idAgenda":"9",
                "dataHora":"2022-02-07 17:00:00"
              }
            ]
          }
        ]
      },
      {
        "data":"2022-02-09",
        "profissionais":[]
      },
      {
        "data":"2022-02-10",
        "profissionais":[]
      },
      {
        "data":"2022-02-11",
       "profissionais":[]
      },
      {
        "data":"2022-02-15",
        "profissionais":[]
      },
      {
        "data":"2022-02-17",
        "profissionais":[]
      },
      {
        "data":"2022-02-18",
       "profissionais":[]
      },
      {
        "data":"2022-02-21",
        "profissionais":[]
      },
      {
        "data":"2022-02-23",
        "profissionais":[]
      }
    ]
}

Retorno da API - Falha

Aviso
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;

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Parâmetros de entrada

Exemplo request

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

Retorno da API - Sucesso

Retorno da API - Sucesso Caso o atributo data (que é opcional) no body da requisição for preenchido

Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido

Retorno da API - Falha