Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Índice
Dica

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

Método "gravarConsulta"

Informações

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ / gravarConsulta

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/gravarConsulta

POST

application/json

Endpoint para listar os registros de consultas relacionadas ao localizador (chaveUnica)

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.

...

Bloco de código
languagejson
{
    "dadosContato:":{
      "nome":"String",
      "celular":"String",
      "email":"String"
    }
}

Exemplo request

Bloco de código
languagejson
url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/gravarConsulta

Body:
{
    "chaveUnica":"101012",
    "integracao":{
      "xpto":"voluptatibus",
      "xyz":"quibusdam",
      "abcdef":9288701
    },
    "tipoAgenda":"1",
    "paciente":{
      "chaveUnica":"101012",
      "numeroContrato":"616161",
      "integracao":{
        "xpto":"voluptatibus",
        "xyz":"quibusdam",
        "abcdef":9288701
      }
    },
    "responsavelAtendimento":{
      "chaveUnica":"3321",
      "numeroContrato":"444456789",
      "integracao":{
        "xpto":"voluptatibus",
        "xyz":"quibusdam",
        "abcdef":9288701
      }
    },
    "dadosContato:":{
      "nome":"Nome do contato",
      "celular":"289999999999",
      "email":"email@teste.com"
    },
    "idEspecialidade":"716171919",
    "idLocal":"818181",
    "idProfissional":"81818",
    "idAgenda":"123123",
    "dataHora":"2022-02-01 11:30:00"
}

 

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.

...

Bloco de código
languagejson
{
  "agenda":{
    "idAgenda":"String",
    "dataHora":"YYYY-MM-DD hh:mm:ss"
  }
}

Retorno da API - Sucesso

Bloco de código
languagejson
{
  "numeroProtocolo":"001002003004005",
  "paciente":{
    "chaveUnica":"123123",
    "nome":"Nome paciente",
    "telefone":"27 99999-9999"
  },
  "profissional":{
    "id":"1231231",
    "nome":"Dr João Silva",
    "conselho":"CRM-ES 123123",
    "especialidade":{
      "id":"123123",
      "descricao":"Cardiologia"
    }
  },
  "agenda":{
    "idAgenda":"123123",
    "dataHora":"2022-02-01 14:00:00"
  }
}
  

Retorno da API - Falha

Aviso