Especificação OpenAPI 3.0.3 embutida para conferência ou importação.
{
"openapi": "3.0.3",
"info": {
"title": "API RaciMED",
"version": "1.2.3",
"description": "Documentação Swagger Style V2.14 gerada a partir do ZIP rAPIV_123.zip"
},
"servers": [
{
"url": "http://localhost:9000",
"description": "Ambiente local"
},
{
"url": "https://racimed.api:90001",
"description": "Ambiente cliente HTTPS"
},
{
"url": "https://cliente.racimednuvem.com.br:90000",
"description": "Modelo por cliente"
}
],
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
}
}
},
"security": [
{
"basicAuth": []
}
],
"paths": {
"/ping": {
"get": {
"tags": [
"Sistema"
],
"summary": "Teste/status do servidor RaciMED API; retorna HTML com data/hora e versão da API.",
"description": "Controller: rAPI.dpr | Handler: procedure",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/medicos": {
"get": {
"tags": [
"Médicos"
],
"summary": "Lista os profissionais/médicos cadastrados.",
"description": "Controller: Controller.medicos.pas | Handler: ListarMedicos",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/medicosespecialidades": {
"get": {
"tags": [
"Médicos"
],
"summary": "Lista especialidades dos profissionais.",
"description": "Controller: Controller.medicos.pas | Handler: ListarMedicosEspecialidades",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/medicoshorarios": {
"get": {
"tags": [
"Médicos"
],
"summary": "Lista profissionais com configuração de horários.",
"description": "Controller: Controller.medicos.pas | Handler: ListarMedicosHorarios",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/medicoshorarios/{idprof}": {
"get": {
"tags": [
"Médicos"
],
"summary": "Lista horários do profissional informado.",
"description": "Controller: Controller.medicos.pas | Handler: ListarMedicosHorarios",
"parameters": [
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/pacientes/{id}": {
"get": {
"tags": [
"Pacientes"
],
"summary": "Consulta paciente por CPF. O parâmetro aceita CPF com ou sem máscara.",
"description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesCPF",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/pacientesID/{id}": {
"get": {
"tags": [
"Pacientes"
],
"summary": "Consulta paciente pelo código interno.",
"description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesID",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/pacientesCEL/{cel}": {
"get": {
"tags": [
"Pacientes"
],
"summary": "Consulta paciente pelo celular.",
"description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesCELULAR",
"parameters": [
{
"name": "cel",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/pacientesCART/{cart}": {
"get": {
"tags": [
"Pacientes"
],
"summary": "Consulta paciente por carteira do convênio.",
"description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesCART",
"parameters": [
{
"name": "cart",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/pacientesaniversariantes/{data}": {
"get": {
"tags": [
"Pacientes"
],
"summary": "Lista pacientes aniversariantes pela data informada.",
"description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesAniversario",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendas": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas cadastradas.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendas",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendas/{id}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas por data ou profissional, conforme parâmetro informado.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasDATA",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendas/{data}/{idprof}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas de uma data para um profissional.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasDATA_PROF",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendas/livres/{data}/{idprof}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista horários livres/ocupados do profissional na data.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasLIVRES",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendas/solivres/{data}/{idprof}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista somente horários livres do profissional na data.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasSOLIVRES",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendasid/{id_agenda}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Consulta agenda pelo ID do agendamento.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasID",
"parameters": [
{
"name": "id_agenda",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendascodpac/{id_codpac}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendamentos vinculados ao código do paciente. Novo na documentação V2.14 / API 1.2.3.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasCODPAC",
"parameters": [
{
"name": "id_codpac",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendascomparecimento/{data}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas com comparecimento na data.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasComparecimento",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendascomparecimento/{data}/{idprof}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas com comparecimento por data e profissional.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasComparecimento",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendasnaocomparecimento/{data}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas de não comparecimento na data.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasNaoComparecimento",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendasnaocomparecimento/{data}/{idprof}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas de não comparecimento por data e profissional.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasNaoComparecimento",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendasocupadas/{idprof}/{data}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista horários ocupados do profissional em uma data.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasOcupadas",
"parameters": [
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendasocupadas/{idprof}/{data}/{data2}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista horários ocupados do profissional em intervalo de datas.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasOcupadas",
"parameters": [
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "data2",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendaslembretes/{id}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista agendas para lembretes por parâmetro informado.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaAgendaslembretesDATA",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendasenviadas/{id}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Marca agenda como enviada/avisada pela API.",
"description": "Controller: COntroller.agendas.pas | Handler: MarcarsAgendasEnviadas",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/tiposdeatendimentos": {
"get": {
"tags": [
"Agendas"
],
"summary": "Lista tipos de atendimento.",
"description": "Controller: COntroller.agendas.pas | Handler: ListaTipos",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendaconfirmacao/{id}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Confirma um agendamento pelo ID.",
"description": "Controller: COntroller.agendas.pas | Handler: ConfirmarHorario",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendadesconfirmacao/{id}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Remove/desfaz confirmação do agendamento pelo ID.",
"description": "Controller: COntroller.agendas.pas | Handler: DesconfirmarHorario",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/desmarcarhorario/{id}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Desmarca/cancela um horário pelo ID.",
"description": "Controller: COntroller.agendas.pas | Handler: DesmarcaHorario",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/elegibilidaderetorno/{data}/{idprof}/{id}/{idconv}": {
"get": {
"tags": [
"Agendas"
],
"summary": "Verifica elegibilidade de retorno para paciente, profissional, data e convênio.",
"description": "Controller: COntroller.agendas.pas | Handler: ElegibilidadeRetorno",
"parameters": [
{
"name": "data",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idprof",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idconv",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/agendarhorario": {
"post": {
"tags": [
"Agendas"
],
"summary": "Inclui um novo agendamento.",
"description": "Controller: COntroller.agendas.pas | Handler: AgendaHorario",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
},
"201": {
"description": "Criado"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"codpac": 0,
"paciente": "NOME DO PACIENTE COMPLETO",
"data": "2026-04-16",
"hora": "11:00",
"codmed": 11,
"codexame": 1,
"fone1": "(11) 98184-8560",
"codtipo": 1,
"tipo": "1ª vez",
"codconv": 1,
"codplano": 1,
"carteira": ""
}
}
}
}
}
},
"/convenios": {
"get": {
"tags": [
"Convênios e Planos"
],
"summary": "Lista convênios cadastrados e ativos.",
"description": "Controller: Controller.convenios.pas | Handler: ListaConvenios",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/planos": {
"get": {
"tags": [
"Convênios e Planos"
],
"summary": "Lista planos cadastrados.",
"description": "Controller: Controller.convenios.pas | Handler: Listaplanos",
"parameters": [],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
},
"/planos/{ID}": {
"get": {
"tags": [
"Convênios e Planos"
],
"summary": "Lista planos filtrados por convênio/ID informado.",
"description": "Controller: Controller.convenios.pas | Handler: ListaplanosID",
"parameters": [
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sucesso"
},
"400": {
"description": "Parâmetros inválidos"
},
"401": {
"description": "Não autorizado"
},
"500": {
"description": "Erro interno"
}
}
}
}
}
}