Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Parâmetro

Obrigatório

Tipo

Descrição

data

Estado
colourGreen
titleTRUE

string

 

Data do agendamento “0000-00-00“

especialidadeId

Estado
colourGreen
titleTRUE

string

 

ID da especialidade do médico

especialidadeNome

Estado
colourGreen
titleTRUE

string

Nome da especialidade do médico

hora

Estado
colourGreen
titleTRUE

string

Hora do atendimento “00:00“

idAgenda

Estado
colourGreen
titleTRUE

string

ID da agenda

idChaveUnicaPaciente

Estado
colourGreen
titleTRUE

string

Login do usuário no app

localizadorMensageria

Estado
colourGreen
titleTRUE

string

Localizador mensageria. Este campo deve coincidir com o localizador de mensageria retornado pela sua API de login

pacienteCpf

Estado
colourGreen
titleTRUE

string

CPF do paciente

pacienteEmail

Estado
colourGreen
titleTRUE

string

Email do paciente

pacienteMatricula

Estado
colourGreen
titleTRUE

string

Matrícula do paciente

pacienteNome

Estado
colourGreen
titleTRUE

string

Nome do paciente

pacienteCelular

Estado
colourGreen
titleTRUE

string

Celular do paciente

idChaveUnicaProfissional

Estado
colourGreen
titleTRUE

string

ID do profissional. Este campo deve coincidir com o campo
chaveUnica do objeto “profissional” do retorno da API de agenda médica

profissionalNome

Estado
colourGreen
titleTRUE

string

Nome do profissional

profissionalNumeroConselho

Estado
colourGreen
titleTRUE

string

NR do conselho do profissional

profissionalSiglaConselho

Estado
colourGreen
titleTRUE

string

Sigla do conselho do profissional

profissionalUfConselho

Estado
colourGreen
titleTRUE

string

UF do conselho do profissional

camposPersonalizados

Estado
colourRed
titleFALSE

array

Array de objetos contendo chave e valor dos campos personalizados informados pelo cliente

5- Body request (JSON).

Bloco de código
{
  "data": "2021-01-26",
  "especialidadeId": "01",
  "especialidadeNome": "Cardiologia",
  "hora": "08:20",
  "idAgenda": "R551",
  "idChaveUnicaPaciente": "joao_t@mobilesaude.com.br",
  "localizadorMensageria" : "joao_t@mobilesaude.com.br",
  "pacienteCpf": "05869310741",
  "pacienteEmail": "joao_t@mobilesaude.com.br",
  "pacienteMatricula": "10001010101",
  "pacienteNome": "João T.",
  "pacienteCelular": "2799999999",
  "idChaveUnicaProfissional" : "208",
  "profissionalNome": João T.",
  "profissionalNumeroConselho": "10020",
  "profissionalSiglaConselho": "CRM",
  "profissionalUfConselho": "ES",
  "camposPersonalizados": [
      {
          "chave": "Teste",
          "valor": "Valor teste"
      },
      {
          "chave": "Teste 2",
          "valor": "Valor teste 2"
      }
  ]
}

6- Retorno com sucesso (200)

...