Pular para o conteúdo principal

Obter agendamentos futuros do beneficiário no Tasy

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v1/agendamentos/beneficiario/futuros?cdUsuarioConvenio={{cdUsuarioConvenio}}&cpf={{cpf}}&cdPessoaFisica={{cdPessoaFisica}}&ieTipoAgenda={{ieTipoAgenda}}

🔹 Produção

https://integracao.medsenior.com.br/api/v1/agendamentos/beneficiario/futuros?cdUsuarioConvenio={{cdUsuarioConvenio}}&cpf={{cpf}}&cdPessoaFisica={{cdPessoaFisica}}&ieTipoAgenda={{ieTipoAgenda}}

É obrigatório informar ao menos um identificador do beneficiário (cdUsuarioConvenio, cpf ou cdPessoaFisica). O parâmetro ieTipoAgenda é opcional e aceita os valores 1, 2, 3 e 4, podendo ser concatenados com vírgula (ex.: 1,3).

📌 Endpoint

GET /api/v1/agendamentos/beneficiario/futuros

🔐 Autenticação

Este endpoint requer um token válido.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

NomeValor
acceptapplication/json
content-typeapplication/json

🔽 Parâmetros de Entrada (query string)

NomeTipoObrigatórioDescrição
cdUsuarioConveniostringCondicionalCódigo da carteirinha do beneficiário no Tasy. Deve ser informado quando cpf e cdPessoaFisica não estiverem presentes.
cpfstringCondicionalCPF do beneficiário. Remover pontuação. Deve ser informado quando cdUsuarioConvenio e cdPessoaFisica não estiverem presentes.
cdPessoaFisicalongCondicionalIdentificador interno (pessoa física) no Tasy. Deve ser informado quando cdUsuarioConvenio e cpf não estiverem presentes.
ieTipoAgendastringNãoFiltro de tipos de agenda: 1 (Exames), 2 (Consulta Médica), 3 (Cirurgia) e 4 (Quimioterapia). Permite múltiplos valores separados por vírgula, ex.: 1,2,4.

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'GET' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/agendamentos/beneficiarios/agendamentos/futuros?cpf=12345678901&ieTipoAgenda=1,3' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'

🔹 Ambiente de produção

curl -X 'GET' \
'https://integracao.medsenior.com.br/api/v1/agendamentos/beneficiarios/agendamentos/futuros?cdUsuarioConvenio=MS123456&ieTipoAgenda=2' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'

✅ Resposta de Sucesso

  • Status Code: 200 OK
  • Exemplo de Resposta:
{
"REF_CURSOR_P": [
{
"NR_SEQ_AGENDA": 987654,
"IE_TIPO_AGENDA": 1,
"DS_TIPO_AGENDA": "Exame",
"TIPO_ITEM": "Principal",
"DT_AGENDA": "15/02/2026",
"HR_AGENDA": "08:30",
"IE_CONFIRMADO": "S",
"DS_STATUS_AGENDA": "Confirmado",
"CD_ESTABELECIMENTO": 104,
"DS_ESTABELECIMENTO": "Unidade Vitória",
"DS_LOCALIZACAO": "Av. Dante Michelini, 435 - Praia do Canto - Vitória, ES",
"CD_PESSOA_FISICA": 11223344,
"NM_PESSOA_FISICA": "João da Silva",
"CD_CONVENIO": 50,
"DS_CONVENIO": "MedSênior",
"CD_CATEGORIA": 2,
"DS_CATEGORIA": "Superior",
"CD_PLANO": 7,
"DS_PLANO": "Premium",
"CD_USUARIO_CONVENIO": "MS123456",
"CD_MED_SOLIC": 9988,
"NM_MED_SOLICITANTE": "Dra. Ana Pereira",
"CRM_SOLIC": "12345",
"UF_CONSELHO_SOLIC": "CRM-ES",
"CD_MEDICO_EXEC": 7766,
"NM_MED_EXEC": "Dr. Carlos Souza",
"CRM_EXEC": "67890",
"UF_CONSELHO_EXEC": "CRM-ES",
"CD_ESPECIALIDADE": 45,
"DS_ESPECIALIDADE": "Cardiologia",
"NR_SEQ_PROC_INTERNO": 555111,
"DS_PROC": "Ecocardiograma",
"LADO": "N/A",
"DS_ORIENTACAO_PROC": "Jejum de 8 horas.",
"NR_MIN_DURACAO": 60,
"CICLO": null
}
],
"CODIGO_P": "0",
"MENSAGEM_P": "Consulta realizada!"
}

ℹ️ Observações de negócio

  • A procedure API_MS_JORNADA_DIG_PCK.MS_AGENDAMENTOS_BENEF retorna agendas de exames, consultas médicas, cirurgias e quimioterapia.
  • Para agendas de exames e cirurgias, o campo TIPO_ITEM sinaliza se o registro é Principal ou um procedimento adicional que ocupa o mesmo slot.
  • IE_CONFIRMADO assume S, N ou NA (cirurgias/quimioterapia não exigem confirmação via app).
  • DS_ORIENTACAO_PROC contém as orientações de preparo exibidas ao beneficiário.
  • Quando ieTipoAgenda não é informado, todos os tipos (1 a 4) serão retornados.

❌ Códigos de Erro

Status CodeSignificadoDescrição
400Bad RequestNenhum identificador informado ou ieTipoAgenda contém valores inválidos.
401UnauthorizedToken ausente ou inválido.
404Not FoundNenhum agendamento futuro localizado para os filtros enviados.
500Server ErrorFalha na execução da procedure Oracle (CODIGO_P = '9').