Cancelar consulta

POST

/simplificav2/consulta/:id/cancelar

Cancela uma consulta já existente. Regras: - a rota usa as mesmas validações operacionais de cancelamento já aplicadas no sistema; - informe `motivo_id` e `descricao`; - o motivo precisa existir, estar ativo e ser válido para cancelamento de consulta; - consultas com oportunidade ativa vinculada não podem ser canceladas por esta rota. Exemplo de uso: ```http POST {{base_url}}/simplificav2/consulta/145/cancelar Authorization: Bearer {{bearer_token}} Content-Type: application/json { "motivo_id": 7, "descricao": "Paciente solicitou cancelamento." } ```

Cancelar consulta

POST

/simplificav2/consulta/:id/cancelar

Cancela uma consulta já existente.

Regras:

a rota usa as mesmas validações operacionais de cancelamento já aplicadas no sistema;
informe motivo_id e descricao;
o motivo precisa existir, estar ativo e ser válido para cancelamento de consulta;
consultas com oportunidade ativa vinculada não podem ser canceladas por esta rota.

Exemplo de uso:

1 POST {{base_url}}/simplificav2/consulta/145/cancelar
2 Authorization: Bearer {{bearer_token}}
3 Content-Type: application/json
4 
5 {
6   "motivo_id": 7,
7   "descricao": "Paciente solicitou cancelamento."
8 }

Authentication

AuthorizationBearer

Token privado usado para consultar dados da plataforma.

Como usar:

obtenha o token privado da sua empresa;
envie Authorization: Bearer SEU_TOKEN_PRIVADO;
não use x-api-key neste módulo.

Path parameters

idintegerRequired

Identificador da consulta.

Request

This endpoint expects an object.

descricaostringRequired

Observação obrigatória do cancelamento.

motivo_idintegerRequired

Identificador do motivo de cancelamento de consulta.

Response

Consulta cancelada com sucesso.

statusstring

mensagemstring

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/consulta/1/cancelar \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"descricao": "string",
>	"motivo_id": 1
>	}'

1	{
2	"status": "sucesso",
3	"mensagem": "Consulta cancelada com sucesso.",
4	"data": {
5	"id": 145
6	}
7	}

$	curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/consulta/1/cancelar \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"descricao": "string",
>	"motivo_id": 1
>	}'

1	{
2	"status": "sucesso",
3	"mensagem": "Consulta cancelada com sucesso.",
4	"data": {
5	"id": 145
6	}
7	}

1	POST {{base_url}}/simplificav2/consulta/145/cancelar
2	Authorization: Bearer {{bearer_token}}
3	Content-Type: application/json
4
5	{
6	"motivo_id": 7,
7	"descricao": "Paciente solicitou cancelamento."
8	}