Versões comparadas

Chave

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

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

Método "

...

listaConsultasPrestador"

Informações
Nota

IMPORTANTE

Os aplicativos e plataformas web refletem os dados conforme são consumidos diretamente da API. Caso haja necessidade de ordenar ou organizar as informações seguindo regras específicas da operadora, essas configurações devem ser realizadas diretamente na API responsável pelo fornecimento dos dados.

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ listaConsultas listaConsultasPrestador

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/listaConsultasPrestador”.

POST

application/json

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

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.

...

Parâmetro

Obrigatório

Tipo

Descrição

codigo_crmcodigoCRM

M

String

 

data

M

String

Data do dia

Exemplo request

url: https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/listaConsultas Body: { "integracao": { "xpto": "voluptatibus", "xyz": "quibusdam", "abcdef": 9288701 }, "chaveUnica
Bloco de código
languagejson
url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/listaConsultasPrestador

Body:
{
  "codigoCRM": "string",
  "dataInicialdata": "YYYY/MM/DD",
  "dataFinal": "YYYY/MM/DD"
}

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.

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Descrição da situação da consulta

Texto livre

id

M

String

id do status

 

cor

M

String

Cor referente ao status

Hexadecimal. com o #. da cor que deseja que seja usada para representar o status da consulta. Ex.: #FF0000

encerrado

OP

Boolean

Consulta cancelado pelo paciente ou saber se esse atendimento está encerrado.RESERVADO. PARAMETRO AINDA NÃO DISPONÍVEL PARA USO. RECOMENDAMOS NÃO ENVIAR AGENDAMENTOS CANCELADOS.

Bloco de código
languagejson
{
    "agendas": [
        {
            "status": {
                "descricao": "string",
                "id": "string",
                "cor": "string"
            }
        }
    ]
}

...

Bloco de código
languagejson
{
    "agendas": [
        {
            "meeting": {
                "idMeeting": "string"
            }
        }
    ]
}

Retorno da API - Sucesso

Bloco de código
languagejson
{
    "agendas": [
        {
            "idAgenda": "121212",
            "dataHora": "2020-08-05 11:40:00",
            "tipoAgenda": "1",
            "profissional": {
                "descricao": "dr xpto",
                "id": "10294747"
            },
            "especialidade": {
                "descricao": "clinica geral",
                "id": "01928",
                "servico":{
                  "idServico" : "001",
                  "procedimento": "003",
                  "descricao" : "String",
                  "exigeAutorizacao": false,
                 }
            },
            "localAtendimento": {
                "descricao": "CIAS",
                "id": "19919",
                "endereco": {
                    "endereco": "rua 1",
                    "numero": "1",
                    "complemento": "apto 1",
                    "bairro": "bairro 1",
                    "cidade": "vitoria",
                    "estado": "ES",
                    "latitude": "121212.1212",
                    "longitude": "12232323.223"
                }
            },
            "status": {
                "descricao": "Agendado",
                "id": "123",
                "cor": "#ua71ja9"
            },
            "paciente": {
                "chaveUnica": "182737464",
                "numeroContrato": "1212",
                "nome": "nome do paciente",
                "idTipoUsuario": "T"
            },
            "configuracoes": {
                "agendaConfirmada": true,
                "permiteCancelar": true
            },
            "meeting":{
                "idMeeting": "6422f5253333f63b0e9e183f"
            }
        }
    ]
}

Retorno da API - Falha

Aviso