| Índice |
|---|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Método "cancelarConsulta"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
http://exemplo.com/detalheDebito /cancelarConsultaPA | 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 |
|---|---|---|---|
idSenha | 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
| Bloco de código | ||
|---|---|---|
| ||
url:
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/cancelarConsultaPA
Body:
{
"chaveUnica" : "101012",
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"idSenha": "6422f5253333f63b0e9e183f",
} |
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 |
|---|---|---|---|---|
cancelado | M | Boolean | Define se a cancelamento da consulta foi efetuado. |
|
mensagem | M | String | Mensagem informativa a ser ao cliente |
|
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"cancelado": false,
"mensagem": "Seus agendamento não pode ser cancelado pois ultrapassou o tempo limite para cancelamento"
} |
| Bloco de código | ||
|---|---|---|
| ||
{
"cancelado": true,
"mensagem": "Sua consulta foi cancelada com sucesso!"
} |
Retorno da API - Falha
| Aviso |
|---|
|