| Índice | ||||
|---|---|---|---|---|
|
...
| Informações |
|---|
|
| Nota |
|---|
IMPORTANTE Os aplicativos e plataformas web refletem os dados conforme são consumidos diretamente da API. Caso haja necessidade de ordenar ou organizar as informações seguindo regras específicas da operadora, essas configurações devem ser realizadas diretamente na API responsável pelo fornecimento dos dados. |
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.com/ listaConsultas listaConsultasPrestador
| POST | application/json | Endpoint para listar os registros de consultas relacionadas ao localizador (codigoCRM) |
...
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.: |
encerrado | OP | Boolean | Consulta cancelado pelo paciente ou saber se esse atendimento está encerrado.RESERVADO. PARAMETRO AINDA NÃO DISPONÍVEL PARA USO. RECOMENDAMOS NÃO ENVIAR AGENDAMENTOS CANCELADOS. |
| Bloco de código | ||
|---|---|---|
| ||
{
"agendas": [
{
"status": {
"descricao": "string",
"id": "string",
"cor": "string"
}
}
]
} |
...
| Aviso |
|---|
|