Cancelar agendamento no Tasy
🌐 URLs dos Ambientes
🔹 Homologação
https://integracao.hml.cloud.medsenior.com.br/api/v1/agendamentos/cancelar
🔹 Produção
https://integracao.medsenior.com.br/api/v1/agendamentos/cancelar
Utilize sempre o motivo de cancelamento cadastrado no Tasy (tabela
AGENDA_MOTIVO_CANCELAMENTO). Sem esse código a procedure rejeitará a solicitação.
📌 Endpoint
POST /api/v1/agendamentos/cancelar
🔐 Autenticação
Este endpoint requer um token de autorização.
Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO
🔽 Cabeçalhos
| Nome | Valor |
|---|---|
| accept | application/json |
| content-type | application/json |
🔽 Corpo da Requisição (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nrSeqAgenda | long | Sim | Identificador do slot que será cancelado (NR_SEQ_AGENDA_P). |
ieTipoAgenda | int | Sim | Tipo da agenda: 1 para exames, 2 para consultas médicas. |
nmUsuario | string | Sim | Usuário (serviço) responsável pelo cancelamento. Máximo de 30 caracteres. |
cdMotivoCancelamento | long | Sim | Motivo do cancelamento informado pelo beneficiário (CD_MOTIVO_CANCEL_P). |
Todos os campos são validados antes do envio ao Tasy. O motivo do cancelamento deve ser maior que zero.
🔄 Exemplo de Requisição
curl -X 'POST' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/agendamentos/cancelamento' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
"nrSeqAgenda": 123456,
"ieTipoAgenda": 1,
"nmUsuario": "servico.jornada",
"cdMotivoCancelamento": 99
}'
✅ Resposta de Sucesso
- Status Code:
200 OK - Exemplo de Resposta:
{
"IE_CONFIRMADO_P": "N",
"IE_CANCELADO_P": "S",
"CODIGO_P": "0",
"MENSAGEM_P": "Agenda cancelada!"
}
ℹ️ Observações de negócio
- O cancelamento atualiza o slot original para “Cancelado”, registra usuário/data/motivo e, segundo o Tasy, gera um novo slot “Livre”.
- O procedimento
API_MS_JORNADA_DIG_PCK.MS_CONFIRMACAO_AGENDAStambém replica o status para “Agenda de Exames”, “Agenda de Consultas” e “Agenda Integrada”. - Quando existirem guias de autorização associadas, o Tasy as cancela automaticamente.
❌ Códigos de Erro
| Status Code | Significado | Descrição |
|---|---|---|
| 400 | Bad Request | Alguma validação de entrada falhou (slot, tipo, usuário ou motivo). |
| 401 | Unauthorized | Token inválido ou ausente. |
| 404 | Not Found | O slot informado não existe (CODIGO_P = 2). |
| 409 | Conflict | O slot já estava cancelado (CODIGO_P = 1). |
| 500 | Server Error | Falha ao executar a procedure no Tasy (CODIGO_P = 9). |