1- URL base API
Ambientes | URL |
---|---|
Produção | |
Homologação |
2- Endpoint
Endpoint | Método | Descrição |
---|---|---|
schedule/cancel | POST | Método cancela uma agenda de acordo com os parâmetros de entrada. |
3- Headers
Campo | Obrigatório | Tipo | Descrição |
---|---|---|---|
| TRUE | string | Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo. |
| FALSE | inteiro | Código de integração da operadora na Mobile Saúde |
Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:
|
4- Parâmetros envio
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
| TRUE | string
| ID da agenda (Sistema do cliente) |
| TRUE | string
| Chave única do paciente |
| TRUE | string | ID do médico (Sistema do cliente) |
| FALSE | array | Array de objetos contendo chave e valor dos campos personalizados. Este campos serão exibidos no emails de cancelamento de agenda. |
5- Body request
{ "idAgendaIntegracao": "200", "idChaveUnicaPaciente": "paciente@email.com.br", "idChaveUnicaProfissional" : "919191", "camposPersonalizados": [ { "chave": "Teste cancelamento", "valor": "Valor teste cancelamento" }, { "chave": "Teste cancelamento 2", "valor": "Valor teste cancelamento 2" } ] }
6- Retorno com sucesso (200)
{ "status": true, "data": {}, "critical": null, "timestamp": "2021-01-19T16:43:56.256Z", "msg": "Agenda cancelada com sucesso." } |
7- Retorno com erro (200)
{ "status": false, "data": {}, "critical": [ { "COD": 0, "DESC": "A propriedade [idAgenda] é obrigatória.", "origem": "", "trace": "", "SOLU": null, "REAL": null, "CONT": null } ], "timestamp": "2021-01-19T16:44:42.868Z", "msg": "A propriedade [idAgenda] é obrigatória." } |