Consulta os dados de um agendamento confirmado usando token.
A consulta a está API retorna as informações ao agendamento que foi confirmado pelo contato anteriormente usando o token que está bo QRCode para a entidade que está sendo consultada.
Checkin (GET) /checkin/bytoken/{entity_id}/{token}
GET https://api.notifier.datanuvem.ai/v1/checkin/bytoken/{entity_id}/{token}
| Parâmetro | Finalidade |
|---|---|
| entity_id | Código da clínica, consultório, ou hospital cadastrado na API. |
| token | Token obtido do QRCode. |
Sim
Nenhum
{
"id": "ckpq3xbh7000101mfpuk6gon3",
"external_id": "1028",
"category": "medical",
"target": "appointment",
"contact": {
"external_id": "2090",
"name": "João da Silva",
"gender": "M",
"language": "pt_BR",
"country": "BR",
"citizen_id": "12345678910",
"birth_date": "1953-03-30"
},
"params": {
"doctor": "Agatha Dias",
"doctor_external_id": "138",
"doctor_expertise": "Cardiologista",
"event_date": "2018-11-25T14:15:29Z",
"day": "25",
"hour": "14",
"when": "2018-11-25T14:15:29Z",
"year": "2018",
"month": "11",
"minute": "15"
},
"files": [],
"inferred_data": {}
}
O campo contact informa informa os dados do contato.
O campo external_id corresponde à chave primária da tabela de agendamentos do seu banco de dados e que foi informado no momento da criaçãoda notificação.
Os campos category, target informa o plugin usado para criar a notificação e o campo params os parametros específicos deste tipo notificação.
No campo params estão os dados do que foi agendado. Estes dados são varáveis, dependendo do category e target.
curl -X GET "https://api.notifier.datanuvem.ai/v1/checkin/bytoken/cjmqw1liu000001rud8lv30t5/cjmqw1liu000001rud8lv5y78" -H "accept: application/json" -H "Authorization: Bearer <COLOQUE AQUI O TOKEN DE AUTENTICAÇAO>" -H "Content-Type: application/json"
O Exemplo acima consulta os dados para a entidade cjmqw1liu000001rud8lv30t5 e o token cjmqw1liu000001rud8lv5y78.
Aviso
O campo params->event_date está no timezone universal UTC.