8.7 - Cancelar consulta

1 Introdução
2 Método "cancelarConsulta"
3 Endpoint

Só são suportadas integrações no padrão REST.

Introdução

Utilize este método para cancelar uma consulta agendada, selecionando na listaConsulta e confirmando o cancelamento.

Método "cancelarConsulta"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
exemplo.com /cancelarConsulta	POST	application/json	Endpoint responsável por efetuar o cancelamento de uma consulta.

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idAgenda	M	Number	Id de banco de dados da consulta no seu sistema interno
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	Nó integração retornado no login do usuário

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/cancelarConsulta

Body:
{
	"chaveUnica" : "101012",                
	"integracao": {
    	"xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "idAgenda": 579,
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
cancelado	M	Boolean	Define se a cancelamento da consulta foi efetuado.
mensagem	M	String	Mensagem informativa a ser ao cliente

Retorno da API - Sucesso

{
  "cancelado": false,
  "mensagem": "Seus agendamento não pode ser cancelado pois ultrapassou o tempo limite para cancelamento"
}

{
  "cancelado": true,
  "mensagem": "Sua consulta foi cancelada com sucesso!"
}

Retorno da API - Falha

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;