Versions Compared

Version Old Version 28 New Version Current
Changes made by

Ranniêr Reis

Jean Schulz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ listaConsultas

Note

Atenção

O endpoint obrigatoriamente deve terminar com “/listaConsultas”.

POST

application/json

Endpoint para listar os registros de consultas relacionadas ao localizador (chaveUnica)

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Descrição da situação da consulta

Texto livre

id

M

String

id do status

 

cor

M

String

Cor referente ao status

Hexadecimal. com o #. da cor que deseja que seja usada para representar o status da consulta. Ex.: #FF0000

encerrado

OP

Boolean

Consulta cancelado pelo paciente ou saber se esse atendimento está encerrado.Indicação de uso

: quando uma consulta está cancelada ou já foi finalizada, informe esse atributo como TRUEOBRIGATÓRIO enviar TRUE quando um agendamento está finalizado. Enviar como TRUE fará com que o lembrete de dias faltantes para o evento será removido, sendo substituído pelo texto do status.

Se o agendamento ainda estiver ativo, Informe FALSE. Isso fará com que o timer de “dias faltantes” seja exibido.

Code Block
languagejson
{
    "agendas": [
        {
            "status": {
                "descricao": "string",
                "id": "string",
                "cor": "string",
                "encerrado": boolean
            }
        }
    ]
}

...