Versões comparadas

Chave

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

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

...

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/detalheDebito /detalheConsulta

POST

application/json

Endpoint que retorna o detalhamento de um débito

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

idAgenda

M

String

id da agenda

 

protocolo

OP

String

Numero de protocolo do agendamento

dataHora

C

String

Data e hora da consulta

Obrigatório para os tipos de agendamento:
1 = Presencial
2 = Teleconsulta

Deve conter dia e hora da consulta.

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

tipoAgenda

M

String

Informe o tipo da agenda

Conteúdo válido:
1 = Presencial
2 = Teleconsulta
3 = Pronto atendimento.
4 = Cabine de atendimento

profissional

M

Objeto

Dados do profissional

Obrigatório para os tipos de agendamento:
1 = Presencial
2 = Teleconsulta

Objeto profissional

especialidade

M

Objeto

Dados da especialidades

 

Obrigatório para os tipos de agendamento:
1 = Presencial
2 = Teleconsulta

Objeto especialidade

localAtendimento

M

Objeto

Objeto com dados do local de atendimento

Obrigatório para os tipos de agendamento:
1 = Presencial

Objeto localAtendimento

status

M

Objeto

Objeto com dados sobre o status da consulta

Objeto status

paciente

M

Objeto

Objeto com dados do paciente

Objeto paciente

configuracoes

M

Objeto

Objeto com dados da configurações da funcionalidade

Objeto configurações 

 

dataTermino

OP

String

Data de termino da consulta

Deve conter dia e hora.

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

anexos

OP

Array <anexo>

Array de anexos

meeting

OP

String

Objeto com dados da meeting

Agendas do tipo teleconsulta

Bloco de código
languagejson
   {
    "idAgenda": "String",
    "protocolo": "String"
    "dataHora": "YYYY-MM-DD hh:mm:ss",
    "tipoAgenda": "String",
    "profissional": { Objeto },
    "especialidade": { Objeto },
    "localAtendimento": { Objeto },
    "status": { Objeto },
    "paciente": { Objeto },
    "configuracoes": { Objeto },
    "anexos": [{ Objeto }]
    "meeting": { objeto }
}

...