juampisor's picture
Organizacion de documentacion
3ac37aa
Raw History Blame Contribute Delete
152 kB
{ "openapi": "3.0.1", "info": { "title": "M贸dulo 2 - Gesti贸n de turnos", "description": "", "version": "1.0.0" }, "tags": [ { "name": "appointments" }, { "name": "notifications" }, { "name": " specialties" }, { "name": "medical-centers" } ], "paths": { "/appointments": { "post": { "summary": "/appointments", "deprecated": false, "description": "Permite crear turnos en el sistema.\n\nNotas: \n1) El valor de la propiedad \"starts_at\" debe ser mayor al instante actual.\n2) La hora del valor de la propiedad \"starts_at\" debe ser entre las 09:00 y las 17:30.\n3) El valor de la propiedad \"ends_at\" no debe superar los 30 minutos exactos en relaci贸n a la propiedad \"starts_at\".\n4) La hora del valor de la propiedad \"ends_at\" debe ser entre las 09:30 y las 18:00.\n5) El valor de la propiedad \"ends_at\" no debe ser anterior al de \"starts_at\".\n6) El valor de la propiedad \"medic_id\" debe ser distinto a \"patient_id\" y viceversa, debido a que si bien son distintos roles ambos son usuarios.\n7) Ejecutar este servicio enviar谩 un mail al paciente y al m茅dico informando sobre la creaci贸n del turno.", "tags": [ "appointments" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "medic_id": { "type": "integer", "description": "ID de usuario asociado al m茅dico del turno", "minimum": 1 }, "patient_id": { "type": "integer", "description": "ID de usuario asociado al paciente del turno", "minimum": 1 }, "center_id": { "type": "integer", "description": "ID asociado al centro m茅dico donde se llevar谩 a cabo el turno", "minimum": 1 }, "speciality_id": { "type": "integer", "description": "ID asociado a la especialidad del m茅dico que el paciente necesitaba", "minimum": 1 }, "starts_at": { "type": "string", "description": "Fecha y hora del inicio del turno", "format": "YYYY-MM-DD HH:mm:ss" }, "ends_at": { "type": "string", "description": "Fecha y hora estipulada de fin del turno", "format": "YYYY-MM-DD HH:mm:ss" } }, "required": [ "medic_id", "patient_id", "center_id", "speciality_id", "starts_at", "ends_at" ] }, "examples": { "1": { "value": { "medic": { "id": 1361561151, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3365611, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 2, "speciality_id": 107, "starts_at": "2026-09-29 12:00:00", "ends_at": "2026-09-29 12:30:00" } }, "summary": "[201] Petici贸n correcta" }, "2": { "value": { "medic": {}, "patient": {}, "appointment": {} }, "summary": "[400] Falta de campos" }, "3": { "value": { "medic": { "id": 123, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 123, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 5, "starts_at": "2026-08-16 11:30:00", "ends_at": "2026-08-16 12:00:00" } }, "summary": "[400] Validaci贸n: patient_id NO es distinto a medic_id" }, "4": { "value": { "medic": { "id": 123, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 5, "starts_at": "2026-05-15 11:30:00", "ends_at": "2026-05-15 12:00:00" } }, "summary": "[400] Validaci贸n: starts_at NO es una fecha y hora futura" }, "5": { "value": { "medic": { "id": 123, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 5, "starts_at": "2026-08-15 10:30:00", "ends_at": "2026-08-15 10:00:00" } }, "summary": "[400] Validaci贸n: starts_at NO es una fecha y hora anterior a ends_at" }, "6": { "value": { "medic": { "id": 123, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 5, "starts_at": "2026-08-15 12:00:00", "ends_at": "2026-08-15 12:31:00" } }, "summary": "[400] Validaci贸n: la diferencia de tiempo entre starts_at y ends_at NO es exactamente 30 minutos" }, "7": { "value": { "medic": { "id": 1233, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 192391395, "starts_at": "2026-08-15 11:00:00", "ends_at": "2026-08-15 11:30:00" } }, "summary": "[404] Validacion: el ID de especialidad NO existe" }, "8": { "value": { "medic": { "id": 1233, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 931231, "speciality_id": 1, "starts_at": "2026-08-15 11:00:00", "ends_at": "2026-08-15 11:30:00" } }, "summary": "[404] Validaci贸n: el ID del centro m茅dico NO existe" }, "9": { "value": { "medic": { "id": 123, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 5, "starts_at": "2026-08-15 11:00:00", "ends_at": "2026-08-15 11:30:00" } }, "summary": "[409] Validaci贸n: el m茅dico NO tiene disponibilidad en la fecha y hora solicitada" }, "10": { "value": { "medic": { "id": 1233, "fullname": "Dr. Juan P茅rez", "email": "juan.perez@test.com" }, "patient": { "id": 3, "fullname": "martin fernandes", "email": "martin@test.com" }, "appointment": { "center_id": 9, "speciality_id": 5, "starts_at": "2026-08-15 11:00:00", "ends_at": "2026-08-15 11:30:00" } }, "summary": "[409] Validaci贸n: el paciente NO tiene disponibilidad en la fecha y hora solicitada" } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "appointment_id": { "type": "integer", "description": "ID del turno generado" }, "notification_id": { "type": "string", "format": "uuid", "description": "ID de la notificaci贸n enviada" } }, "required": [ "appointment_id", "notification_id" ] }, "example": { "appointment_id": 330, "notification_id": "88f84ba0-d397-400f-8958-68b22846c487" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "medic_id", "message": "medic_id is required" }, { "field": "patient_id", "message": "patient_id is required" }, { "field": "center_id", "message": "center_id is required" }, { "field": "speciality_id", "message": "speciality_id is required" }, { "field": "starts_at", "message": "starts_at is required" }, { "field": "ends_at", "message": "ends_at is required" } ] } }, "3": { "summary": "Validaci贸n: patient_id NO es distinto a medic_id", "value": { "error": "Validation error", "details": [ { "field": "body.patient.id", "message": "medic.id and patient.id cannot be the same" } ] } }, "4": { "summary": "Validaci贸n: starts_at NO es una fecha y hora futura", "value": { "error": "Validation error", "details": [ { "field": "body.appointment.starts_at", "message": "appointment.starts_at cannot be in the past" } ] } }, "5": { "summary": "Validaci贸n: starts_at NO es una fecha y hora anterior a ends_at", "value": { "error": "Validation error", "details": [ { "field": "body.appointment.starts_at", "message": "appointment.starts_at must be before appointment.ends_at" } ] } }, "6": { "summary": "Validaci贸n: la diferencia de tiempo entre starts_at y ends_at NO es exactamente 30 minutos", "value": { "error": "Validation error", "details": [ { "field": "body.appointment.ends_at", "message": "the difference between appointment.starts_at and appointment.ends_at must be equal to 30 minutes" } ] } } } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "examples": { "7": { "summary": "Validacion: el ID de especialidad NO existe", "value": { "error": "NotFoundError", "message": "Speciality id 192391395 not found", "timestamp": "2026-06-19T13:27:03.887Z" } }, "8": { "summary": "Validaci贸n: el ID del centro m茅dico NO existe", "value": { "error": "NotFoundError", "message": "Medical center id 931231 not found", "timestamp": "2026-06-19T13:29:06.571Z" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" }, "timestamp": { "type": "string", "description": "Fecha y hora de la solicitud", "format": "IS0 8601" } }, "required": [ "error", "message", "timestamp" ] }, "examples": { "9": { "summary": "Validaci贸n: el m茅dico NO tiene disponibilidad en la fecha y hora solicitada", "value": { "error": "ConflictError", "message": "Scheduling conflict: the medic already has an overlapping appointment for the given time range", "timestamp": "2026-06-19T12:56:58.262Z" } }, "10": { "summary": "Validaci贸n: el paciente NO tiene disponibilidad en la fecha y hora solicitada", "value": { "error": "ConflictError", "message": "Scheduling conflict: the patient already has an overlapping appointment for the given time range", "timestamp": "2026-06-19T13:08:23.215Z" } } } } }, "headers": {} }, "500": { "$ref": "#/components/responses/ERROR - Internal server error", "description": "" } }, "security": [] }, "get": { "summary": "/appointments", "deprecated": false, "description": "Permite obtener, de manera paginada, todos los turnos dentro de un rango de fechas. \nLa informaci贸n obtenida de este servicio depende de si est谩 o no el mock activo.\n\nEn caso de que el mock est茅 activo:\nSe utilizan datos mockeados para la mayor铆a de los campos relacionado a los objetos \"patient\", \"medic\", \"speciality\" y \"medical_center\".\nEn los campos enumerados anteriormente, solo los IDs son datos reales que llegaron al endpoint POST /appointments al momento de crear el turno.\n\nEn caso de que el mock NO est茅 activo:\nSe utilizan los servicios del core para obtener los nombres y emails de los usuarios (tanto para los pacientes como los m茅dicos), y las especialidades m茅dicas.\n\nNotas: \n1) El rango de las fechas a consultar no debe superar el mes.\n2) El par谩metro \"until\" debe ser una fecha posterior al par谩metro \"since\".\n3) Todos los campos opcionales sirven como filtros. \n4) Enviar m煤ltiples par谩metros opcionales hace que se filtre m谩s especificamente.\n5) Si se env铆a \"light_response\" = 1 tambi茅n debe enviarse speciality_id y medical_center_id obligatoriamente. \n - Al consultar por la versi贸n \"light_response\", debe tener en cuenta que la estructura del response body asociado al httpcode 200 var铆a.", "tags": [ "appointments" ], "parameters": [ { "name": "since", "in": "query", "description": "Fecha y hora desde la que se consultar谩", "required": true, "example": "2026-04-10 00:00:00", "schema": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss" } }, { "name": "until", "in": "query", "description": "Fecha y hora hasta la que se consultar谩", "required": true, "example": "2026-05-10 00:00:00", "schema": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss" } }, { "name": "page", "in": "query", "description": "N煤mero de p谩gina para los resultados.", "required": false, "example": 1, "schema": { "type": "integer", "minimum": 1, "default": 1, "writeOnly": true } }, { "name": "patient_id", "in": "query", "description": "ID de usuario asociado al paciente a obtener los turnos", "required": false, "example": 77, "schema": { "type": "integer", "minimum": 1 } }, { "name": "medic_id", "in": "query", "description": "ID de usuario asociado al m茅dico a obtener los turnos", "required": false, "example": 1, "schema": { "type": "integer", "minimum": 1 } }, { "name": "medical_center_id", "in": "query", "description": "ID del centro m茅dico a obtener los turnos", "required": false, "example": 1, "schema": { "type": "integer", "minimum": 1 } }, { "name": "speciality_id", "in": "query", "description": "ID de la especialidad a obtener los turnos", "required": false, "example": 1, "schema": { "type": "integer", "minimum": 1 } }, { "name": "light_response", "in": "query", "description": "Sirve como para cambiar el response body para m谩s eficiencia en la conectividad", "required": false, "example": 1, "schema": { "type": "integer", "minimum": 0, "maximum": 1, "writeOnly": true } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "appointments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado al turno" }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "CONFIRMED", "CANCELLED", "CHECKED_IN", "IN_PROGRESS", "COMPLETED", "ABSENT", "EXPIRED" ], "readOnly": true, "description": "Estado actual del turno" }, "starts_at": { "type": "string", "description": "Fecha y hora del inicio del turno", "format": "YYYY-MM-DD HH:mm:ss" }, "ends_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "description": "Fecha y hora estipulada de fin del turno" }, "confirmed_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el paciente confirm贸 su turno", "nullable": true }, "absent_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el sistema determin贸 que el paciente no se present贸 a su turno habiendo confirmado su presencia", "nullable": true }, "expired_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el sistema determin贸 que el paciente no confirm贸 su presencia estando a menos de 24h de inicio de su turno", "nullable": true }, "checked_in_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el paciente se recepcion贸", "nullable": true }, "cancelled_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el paciente cancel贸 su turno", "nullable": true }, "completed_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el m茅dico marc贸 como finalizado el turno", "nullable": true }, "started_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "default": "null", "description": "Fecha y hora de cuando el m茅dico asociado al turno llam贸 al paciente a su sala", "nullable": true }, "created_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "description": "Fecha y hora de cuando el paciente solicit贸 el turno" }, "patient": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID de usuario asociado al paciente del turno" }, "fullname": { "type": "string", "description": "Nombre completo del paciente" }, "email": { "type": "string", "description": "Email del paciente", "format": "email" } }, "required": [ "id", "fullname", "email" ], "description": "Informaci贸n relacionada al paciente del turno" }, "medic": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID de usuario asociado al m茅dico del turno" }, "fullname": { "type": "string", "format": "email", "description": "Nombre completo del m茅dico" }, "email": { "type": "string", "description": "Email del m茅dico" } }, "required": [ "id", "fullname", "email" ], "description": "Informaci贸n relacionada al m茅dico del turno" }, "speciality": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado a la especialidad del m茅dico que el paciente necesitaba" }, "name": { "type": "string", "description": "Nombre de la especialidad" }, "is_high_complexity": { "type": "integer", "description": "Determina si es una especialidad de alta complejidad o no. Esto se hizo para el M贸dulo 6.\n0 = No.\n1 = S铆" } }, "required": [ "id", "name", "is_high_complexity" ], "description": "Informaci贸n relacionada a la especialidad del turno" }, "medical_center": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado al centro m茅dico donde se llevar谩 a cabo el turno" }, "name": { "type": "string", "description": "Nombre del centro m茅dico en el que se llevar谩 a cabo el turno" } }, "required": [ "id", "name" ], "description": "Informaci贸n relacionada al centro m茅dico del turno" } }, "required": [ "status", "id", "starts_at", "ends_at", "confirmed_at", "absent_at", "expired_at", "checked_in_at", "cancelled_at", "completed_at", "started_at", "created_at", "patient", "medic", "speciality", "medical_center" ], "description": "Informaci贸n relacionada al turno" }, "description": "Lista con los turnos que cumplen los par谩metros solicitados" }, "pagination": { "type": "object", "properties": { "total_appointments": { "type": "integer", "description": "N煤mero de turnos dentro de la p谩gina consultada ", "maximum": 15, "minimum": 1, "readOnly": true }, "total_pages": { "type": "integer", "description": "N煤mero total de p谩ginas posibles de consultar, que cumplen con los par谩metros solicitados", "minimum": 1 }, "appointments_per_page": { "type": "integer", "description": "N煤mero de turnos m谩ximos por p谩gina", "const": 15, "readOnly": true } }, "required": [ "total_appointments", "total_pages", "appointments_per_page" ], "description": "Informaci贸n relacionada a la paginaci贸n disponible para los turnos que cumplen los par谩metros solicitados" } }, "required": [ "appointments", "pagination" ] }, "example": { "appointments": [ { "id": 2, "status": "CHECKED_IN", "starts_at": "2026-04-11 01:22:00", "ends_at": "2026-04-11 02:22:00", "confirmed_at": "2026-04-14 07:14:02", "absent_at": null, "expired_at": null, "checked_in_at": "2026-04-14 07:14:27", "cancelled_at": null, "completed_at": null, "started_at": null, "created_at": "2026-04-10 03:56:48", "patient": { "id": 1, "fullname": "Federico Herrera", "email": "federico.herrera@mock.com" }, "medic": { "id": 1, "fullname": "Agustina Medina", "email": "agustina.medina@mock.com" }, "speciality": { "id": 1, "name": "test", "is_high_complexity": 1 }, "medical_center": { "id": 1, "name": "Hospital Italiano de Buenos Aires - Sede Almagro" } } ], "pagination": { "total_appointments": 1, "total_pages": 1, "appointments_per_page": 15 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus errores asociados" } }, "required": [ "error", "details" ] }, "examples": { "3": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "query.since", "message": "since is required" }, { "field": "query.until", "message": "until is required" } ] } }, "4": { "summary": "Validaci贸n: al enviar light_version = 1 NO enviaron medical_center_id o speciality_id", "value": { "error": "Validation error", "details": [ { "field": "query.light_response", "message": "if light_response=1, speciality_id and medical_center_id are required" } ] } }, "5": { "summary": "Validaci贸n: until NO supera since", "value": { "error": "Validation error", "details": [ { "field": "query.since", "message": "since must be before until" } ] } }, "6": { "summary": "Validaci贸n: la ventana de tiempo a consultar NO supera el mes", "value": { "error": "Validation error", "details": [ { "field": "query.until", "message": "the difference between since and until must not be greater than 1 month" } ] } }, "7": { "summary": "Validaci贸n: patient_id NO es distinto a medic_id", "value": { "error": "Validation error", "details": [ { "field": "query.patient_id", "message": "medic_id and patient_id cannot be the same" } ] } } } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "NotFoundError", "message": "No appointments found for the given criteria", "timestamp": "2026-06-24T04:30:35.730Z" } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to retrieve appointments", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/326": { "get": { "summary": "/appointments/<id>", "deprecated": false, "description": "Permite obtener la informaci贸n asociada a un turno seg煤n su ID.\nLa informaci贸n obtenida de este servicio depende de si est谩 o no el mock activo.\n\nEn caso de que el mock est茅 activo:\nSe utilizan datos mockeados para la mayor铆a de los campos relacionado a los objetos \"patient\", \"medic\", \"speciality\" y \"medical_center\".\nEn los campos enumerados anteriormente, solo los IDs son datos reales que llegaron al endpoint POST /appointments al momento de crear el turno.\n\nEn caso de que el mock NO est茅 activo:\nSe utilizan los servicios del core para obtener los nombres y emails de los usuarios (tanto para los pacientes como los m茅dicos), y las especialidades m茅dicas.", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado al turno" }, "status": { "type": "string", "description": "Estado actual del turno", "enum": [ "PENDING_CONFIRMATION", "CONFIRMED", "CANCELLED", "CHECKED_IN", "IN_PROGRESS", "COMPLETED", "ABSENT", "EXPIRED" ], "readOnly": true }, "starts_at": { "type": "string", "description": "Fecha y hora del inicio del turno", "format": "YYYY-MM-DD HH:mm:ss" }, "ends_at": { "type": "string", "description": "Fecha y hora estipulada de fin del turno", "format": "YYYY-MM-DD HH:mm:ss" }, "expired_at": { "type": "string", "description": "Fecha y hora de cuando el sistema determin贸 que el paciente no confirm贸 su presencia estando a menos de 24h de inicio de su turno", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "confirmed_at": { "type": "string", "description": "Fecha y hora de cuando el paciente confirm贸 su turno", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "absent_at": { "type": "string", "description": "Fecha y hora de cuando el sistema determin贸 que el paciente no se present贸 a su turno habiendo confirmado su presencia", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "checked_in_at": { "type": "string", "description": "Fecha y hora de cuando el paciente se recepcion贸", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "cancelled_at": { "type": "string", "description": "Fecha y hora de cuando el paciente cancel贸 su turno", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "completed_at": { "type": "string", "description": "Fecha y hora de cuando el m茅dico marc贸 como finalizado el turno", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "started_at": { "type": "string", "description": "Fecha y hora de cuando el m茅dico asociado al turno llam贸 al paciente a su sala", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "description": "Fecha y hora de cuando el paciente solicit贸 el turno", "format": "YYYY-MM-DD HH:mm:ss", "readOnly": true, "nullable": true }, "patient": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID de usuario asociado al paciente del turno" }, "fullname": { "type": "string", "description": "Nombre completo del paciente" }, "email": { "type": "string", "description": "Email del paciente", "format": "email" } }, "title": "", "description": "Informaci贸n relacionada al paciente del turno", "required": [ "id", "fullname", "email" ] }, "medic": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID de usuario asociado al m茅dico del turno" }, "fullname": { "type": "string", "description": "Nombre completo del m茅dico" }, "email": { "type": "string", "description": "Email del m茅dico", "format": "email" } }, "required": [ "id", "fullname", "email" ], "description": "Informaci贸n relacionada al m茅dico del turno" }, "speciality": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado a la especialidad del m茅dico que el paciente necesitaba" }, "name": { "type": "string", "description": "Nombre de la especialidad", "readOnly": true }, "is_high_complexity": { "type": "integer", "description": "Determina si es una especialidad de alta complejidad o no. Esto se hizo para el M贸dulo 6.\n0 = No.\n1 = S铆" } }, "required": [ "id", "name", "is_high_complexity" ], "description": "Informaci贸n relacionada a la especialidad del turno" }, "medical_center": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado al centro m茅dico donde se llevar谩 a cabo el turno" }, "name": { "type": "string", "description": "Nombre del centro m茅dico en el que se llevar谩 a cabo el turno", "readOnly": true } }, "required": [ "id", "name" ], "description": "Informaci贸n relacionada al centro m茅dico del turno" } }, "required": [ "id", "status", "starts_at", "ends_at", "expired_at", "confirmed_at", "absent_at", "checked_in_at", "cancelled_at", "completed_at", "started_at", "created_at", "patient", "medic", "speciality", "medical_center" ], "description": "Informaci贸n relacionada al turno" }, "example": { "id": 1, "status": "CANCELLED", "starts_at": "2026-04-09 23:37:55", "ends_at": "2026-04-10 00:37:59", "expired_at": null, "confirmed_at": "2026-04-14 05:00:10", "absent_at": null, "checked_in_at": null, "cancelled_at": "2026-04-24 18:43:07", "completed_at": null, "started_at": null, "created_at": "2026-04-10 02:38:16", "patient": { "id": 1, "fullname": "Paula Moreno", "email": "paula.moreno@mock.com" }, "medic": { "id": 1, "fullname": "Julieta Castro", "email": "julieta.castro@mock.com" }, "speciality": { "id": 11, "name": "Urolog铆a", "is_high_complexity": 0 }, "medical_center": { "id": 1, "name": "Hospital Italiano de Buenos Aires - Sede Almagro" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus errores asociados" } }, "required": [ "error", "details" ] }, "example": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } } }, "headers": {} }, "404": { "$ref": "#/components/responses/ERROR - Not found", "description": "" }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to find appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/360": { "delete": { "summary": "/appointments/<id>", "deprecated": false, "description": "Permite cancelar un turno seg煤n su ID.\n\nLa cancelaci贸n es una baja l贸gica, es decir que no se borra el registro sino que simplemente cambia su estado a \"CANCELLED\".\n\nNotas:\n1) Solo se pueden cancelar los turnos que est茅n con estado \"PENDING_CONFIRMATION\" o \"CONFIRMED\".\n2) Ejecutar este servicio enviar谩 un mail al paciente y al m茅dico informando sobre la cancelaci贸n del turno.\n3) Ejecutar este servicio enviar谩 un webhook al M贸dulo 5 cuando se trate de un turno relacionado a una especialidad de alta complejidad, o al M贸dulo 6 cuando se trate espec铆ficamente de quir贸fano.\n - En caso de dudas, consultar anexo de webhooks.", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Resultado de la operaci贸n" }, "notification_id": { "type": "string", "description": "ID de la notificaci贸n enviada", "format": "uuid" } }, "required": [ "message", "notification_id" ] }, "example": { "message": "Appointment cancelled successfully", "notification_id": "720a16c3-45d2-411d-b066-833902262c9a" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus errores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } }, "3": { "summary": "Validaci贸n: el estado del turno NO es \"PENDING_CONFIRMATION\" o \"CONFIRMED\"", "value": { "error": "BadRequestError", "message": "Appointment id 320 was not found or status change was not allowed from CANCELLED", "timestamp": "2026-06-24T03:45:09.845Z" } } } } }, "headers": {} }, "404": { "$ref": "#/components/responses/ERROR - Not found", "description": "" }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to perform operation on appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/320/notifications": { "get": { "summary": "/appointments/<id>/notifications", "deprecated": false, "description": "", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [] } }, "/appointments/360/confirm": { "patch": { "summary": "/appointments/<id>/confirm", "deprecated": false, "description": "Permite confirmar un turno seg煤n su ID.\n\nNotas:\n1) Solo se pueden confirmar los turnos que est茅n con estado \"PENDING_CONFIRMATION\".\n2) Ejecutar este servicio enviar谩 un mail al paciente y al m茅dico informando sobre la confirmaci贸n del turno.", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Resultado de la operaci贸n" }, "notification_id": { "type": "string", "format": "uuid", "description": "ID de la notificaci贸n enviada" } }, "required": [ "message", "notification_id" ] }, "example": { "message": "Appointment confirmed successfully", "notification_id": "592ac449-ead9-4211-950d-818c6b944c83" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus errores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } }, "3": { "summary": "Validaci贸n: el estado del turno NO es \"PENDING_CONFIRMATION\"", "value": { "error": "BadRequestError", "message": "Appointment id 320 was not found or status change was not allowed from CONFIRMED", "timestamp": "2026-06-24T03:49:41.835Z" } } } } }, "headers": {} }, "404": { "$ref": "#/components/responses/ERROR - Not found", "description": "" }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to perform operation on appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/360/check-in": { "patch": { "summary": "/appointments/<id>/check-in", "deprecated": false, "description": "Permite hacer el check-in de un turno seg煤n su ID.\n\nNotas:\n1) Solo se le puede hacer check-in a los turnos que est茅n con estado \"CONFIRMED\".\n2) Ejecutar este servicio enviar谩 un mail al paciente y al m茅dico informando sobre el check-in del turno.\n3) Ejecutar este servicio enviar谩 un webhook al M贸dulo 1 por registro de presentismo del paciente. \n - En caso de dudas, consultar anexo de webhooks.", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Resultado de la operaci贸n" }, "notification_id": { "type": "string", "description": "ID de la notificaci贸n enviada", "format": "uuid" } }, "required": [ "message", "notification_id" ] }, "example": { "message": "Appointment checked-in successfully", "notification_id": "9dd641d6-40f6-4de9-8fbc-813c297723a5" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus errores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } }, "3": { "summary": "Validaci贸n: el estado del turno NO es \"CONFIRMED\"", "value": { "error": "BadRequestError", "message": "Appointment id 320 was not found or status change was not allowed from CHECKED_IN", "timestamp": "2026-06-24T03:58:00.208Z" } } } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "NotFoundError", "message": "Appointment id 12 not found", "timestamp": "2026-04-10T03:04:19.021Z" } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to perform operation on appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/359/reschedule": { "patch": { "summary": "/appointments/<id>/reschedule", "deprecated": false, "description": "Permite reprogramar un turno seg煤n su ID.\n\nNotas:\n1) El valor de la propiedad \"starts_at\" debe ser mayor al instante actual.\n2) La hora del valor de la propiedad \"starts_at\" debe ser entre las 09:00 y las 17:30.\n3) El valor de la propiedad \"ends_at\" no debe superar los 30 minutos exactos en relaci贸n a la propiedad \"starts_at\".\n4) La hora del valor de la propiedad \"ends_at\" debe ser entre las 09:30 y las 18:00.\n5) El valor de la propiedad \"ends_at\" no debe ser anterior al de \"starts_at\".\n6) Los valores de \"starts_at\" y \"ends_at\" deben ser distintos a los actuales del turno.\n7) Solo se pueden reprogramar los turnos que est茅n con estado \"PENDING_CONFIRMATION\" o \"CONFIRMED\".\n8) Ejecutar este servicio cambiara el estado del turno a \"PENDING_CONFIRMATION\" y enviar谩 un mail al paciente y al m茅dico informando sobre la reprogramaci贸n del turno.\n9) Ejecutar este servicio enviar谩 un webhook al M贸dulo 5 cuando se trate de un turno relacionado a una especialidad de alta complejidad, o al M贸dulo 6 cuando se trate espec铆ficamente de quir贸fano.\n - En caso de dudas, consultar anexo de webhooks.", "tags": [ "appointments" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "description": "Nueva fecha y hora del inicio del turno" }, "ends_at": { "type": "string", "format": "YYYY-MM-DD HH:mm:ss", "description": "Nueva fecha y hora estipulada de fin del turno" } }, "required": [ "starts_at", "ends_at" ] }, "example": { "starts_at": "2026-09-27 10:00:31", "ends_at": "2026-09-27 10:30:31" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Resultado de la operaci贸n" }, "notification_id": { "type": "string", "format": "uuid", "description": "ID de la notificaci贸n enviada" } }, "required": [ "message", "notification_id" ] }, "example": { "message": "Appointment rescheduled successfully", "notification_id": "1824411c-c9f9-4fa5-bdf2-7bfd410b5a43" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus errores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "body.starts_at", "message": "starts_at is required" }, { "field": "body.ends_at", "message": "ends_at is required" } ] } }, "3": { "summary": "Validaci贸n: starts_at NO es una fecha y hora futura", "value": { "error": "Validation error", "details": [ { "field": "body.starts_at", "message": "starts_at cannot be in the past" } ] } }, "4": { "summary": "Validaci贸n: el estado del turno NO es \"PENDING_CONFIRMATION\" o \"CONFIRMED\"", "value": { "error": "BadRequestError", "message": "Appointment id 320 was not found or status change was not allowed from CHECKED_IN", "timestamp": "2026-06-24T04:08:06.027Z" } }, "5": { "summary": "Validaci贸n: starts_at NO es una fecha y hora distinta a la actual", "value": { "error": "BadRequestError", "message": "The new start time must be different from the current one", "timestamp": "2026-06-24T04:09:43.535Z" } }, "6": { "summary": "Validaci贸n: la diferencia de tiempo entre starts_at y ends_at NO es exactamente 30 minutos", "value": { "error": "Validation error", "details": [ { "field": "body.ends_at", "message": "the difference between starts_at and ends_at must be equal to 30 minutes" } ] } }, "7": { "summary": "Validaci贸n: starts_at NO est谩 dentro del rango horario permitido", "value": { "error": "Validation error", "details": [ { "field": "body.starts_at", "message": "starts_at must be between 09:00:00 and 17:30:00" } ] } }, "8": { "summary": "Validaci贸n: ends_at NO est谩 dentro del rango horario permitido", "value": { "error": "Validation error", "details": [ { "field": "body.starts_at", "message": "starts_at must be between 09:00:00 and 17:30:00" }, { "field": "body.ends_at", "message": "ends_at must be between 09:30:00 and 18:00:00" } ] } } } } }, "headers": {} }, "404": { "$ref": "#/components/responses/ERROR - Not found", "description": "" }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to perform operation on appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/320/start": { "patch": { "summary": "/appointments/<id>/start", "deprecated": false, "description": "Permite iniciar un turno seg煤n su ID.\n\nNotas:\n1) Solo se pueden iniciar los turnos que tengan estado \"CHECKED_IN\".\n2) Este endpoint lo utilizan desde el M贸dulo 1 para mantener los estados de los turnos near-realtime.", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Resultado de la operaci贸n" } }, "required": [ "message" ] }, "example": { "message": "Appointment started successfully" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } }, "3": { "summary": "Validaci贸n: el estado del turno NO es \"CHECKED_IN\"", "value": { "error": "BadRequestError", "message": "Appointment id 320 was not found or status change was not allowed from PENDING_CONFIRMATION", "timestamp": "2026-06-24T04:17:27.934Z" } } } } }, "headers": {} }, "404": { "$ref": "#/components/responses/ERROR - Not found", "description": "" }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to perform operation on appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/appointments/320/finish": { "patch": { "summary": "/appointments/<id>/finish", "deprecated": false, "description": "Permite finalizar un turno seg煤n su ID.\n\nNotas: \n1) Solo se pueden finalizar los turnos que tengan estado \"IN_PROGRESS\".\n2) Ejecutar este servicio enviar谩 un mail al paciente y al m茅dico informando sobre la finalizaci贸n del turno.\n3) Este endpoint lo utilizan desde el M贸dulo 1 para mantener los estados de los turnos near-realtime.", "tags": [ "appointments" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Resultado de la operaci贸n" }, "notificationId": { "type": "string", "format": "uuid", "description": "ID de la notificaci贸n enviada" } }, "required": [ "message", "notificationId" ] }, "example": { "message": "Appointment finished successfully", "notification_id": "97395c75-ba8a-4205-90e2-61c42a4cab8d" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "examples": { "2": { "summary": "Falta de campos", "value": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } }, "3": { "summary": "Validaci贸n: el estado del turno NO es \"IN_PROGRESS\"", "value": { "error": "BadRequestError", "message": "Appointment id 320 was not found or status change was not allowed from COMPLETED", "timestamp": "2026-06-24T04:24:51.295Z" } } } } }, "headers": {} }, "404": { "$ref": "#/components/responses/ERROR - Not found", "description": "" }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to perform operation on appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/notifications": { "get": { "summary": "/notifications", "deprecated": false, "description": "", "tags": [ "notifications" ], "parameters": [ { "name": "since", "in": "query", "description": "", "required": false, "example": "2026-06-19 00:00:00", "schema": { "type": "string" } }, { "name": "until", "in": "query", "description": "", "required": false, "example": "2026-06-20 00:00:00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [] } }, "/notifications/1": { "get": { "summary": "/notifications/<id>", "deprecated": false, "description": "", "tags": [ "notifications" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [] } }, "/specialities": { "get": { "summary": " /specialities", "deprecated": false, "description": "Permite obtener, de manera paginada, todas las especialidades mockedas.\n\nEste servicio existe como utilitario para consultar nuestros mocks en caso de necesitar, en el flujo real se utilizar谩 el servicio correspondiente del M贸dulo 10.", "tags": [ " specialties" ], "parameters": [ { "name": "is_high_complexity", "in": "query", "description": "Filtra las especialidad de alta complejidad o no. Esto se hizo para el M贸dulo 6.\n0 = No.\n1 = S铆", "required": false, "example": 99, "schema": { "type": "integer", "minimum": 0, "maximum": 1 } }, { "name": "page", "in": "query", "description": "N煤mero de p谩gina para los resultados.", "required": false, "example": 3, "schema": { "type": "integer", "default": 1, "writeOnly": true, "minimum": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "specialities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado a la especialidad" }, "name": { "type": "string", "description": "Nombre de la especialidad" }, "is_high_complexity": { "type": "integer", "description": "Determina si es una especialidad de alta complejidad o no. Esto se hizo para el M贸dulo 6.\n0 = No.\n1 = S铆", "minimum": 0, "maximum": 1 }, "type": { "type": "string", "enum": [ "CONSULTATION", "STUDY", "SURGERY" ], "readOnly": true, "description": "Determina qu茅 tipo de especialidad es " } }, "required": [ "id", "name", "is_high_complexity", "type" ], "description": "Informaci贸n relacionada a la especialidad" }, "description": "Lista con las especialidades que cumplen los par谩metros solicitados" }, "pagination": { "type": "object", "properties": { "total_specialities": { "type": "integer", "description": "N煤mero de especialidades dentro de la p谩gina consultada ", "minimum": 1, "maximum": 15, "readOnly": true }, "total_pages": { "type": "integer", "description": "N煤mero total de p谩ginas posibles de consultar, que cumplen con los par谩metros solicitados", "minimum": 1 }, "specialities_per_page": { "type": "integer", "description": "N煤mero de especialidades m谩ximas por p谩gina", "const": 15, "readOnly": true } }, "required": [ "total_specialities", "total_pages", "specialities_per_page" ], "description": "Informaci贸n relacionada a la paginaci贸n disponible para las especialidades que cumplen los par谩metros solicitados" } }, "required": [ "specialities", "pagination" ] }, "example": { "specialities": [ { "id": 24, "name": "Fonoaudiolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 15, "name": "Gastroenterolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 4, "name": "Ginecolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 16, "name": "Hematolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 30, "name": "Hemodinamia", "is_high_complexity": 1, "type": "STUDY" }, { "id": 36, "name": "Holter 24hs", "is_high_complexity": 1, "type": "STUDY" }, { "id": 17, "name": "Infectolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 23, "name": "Kinesiolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 45, "name": "Litotricia", "is_high_complexity": 1, "type": "STUDY" }, { "id": 33, "name": "Mamograf铆a Digital", "is_high_complexity": 1, "type": "STUDY" }, { "id": 49, "name": "Mapeo Cerebral", "is_high_complexity": 1, "type": "STUDY" }, { "id": 31, "name": "Medicina Nuclear", "is_high_complexity": 1, "type": "STUDY" }, { "id": 18, "name": "Nefrolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 13, "name": "Neumonolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" }, { "id": 103, "name": "Neurocirug铆a", "is_high_complexity": 1, "type": "SURGERY" } ], "pagination": { "total_specialities": 66, "total_pages": 5, "specialities_per_page": 15 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "example": { "error": "Validation error", "details": [ { "field": "query.is_high_complexity", "message": "is_high_complexity must be 0 or 1" } ] } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to retrieve specialities", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/specialities/5": { "get": { "summary": " /specialities/<id>", "deprecated": false, "description": "Permite obtener la informaci贸n mock asociada a una especialidad seg煤n su ID.\n\nEste servicio existe como utilitario para consultar nuestros mocks en caso de necesitar, en el flujo real se utilizar谩 el servicio correspondiente del M贸dulo 10.", "tags": [ " specialties" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado a la especialidad" }, "name": { "type": "string", "description": "Nombre de la especialidad" }, "is_high_complexity": { "type": "integer", "description": "Determina si es una especialidad de alta complejidad o no. Esto se hizo para el M贸dulo 6.\n0 = No.\n1 = S铆" }, "type": { "type": "string", "readOnly": true, "enum": [ "CONSULTATION", "STUDY", "SURGERY" ], "description": "Determina qu茅 tipo de especialidad es " } }, "required": [ "id", "name", "is_high_complexity", "type" ] }, "example": { "id": 5, "name": "Traumatolog铆a", "is_high_complexity": 0, "type": "CONSULTATION" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "example": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "NotFoundError", "message": "Speciality id 9999 not found", "timestamp": "2026-06-24T04:28:14.648Z" } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to find speciality", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/medical-centers": { "get": { "summary": " /medical-centers", "deprecated": false, "description": "Permite obtener, de manera paginada, todas los centros m茅dicos ordenados seg煤n se requiera.\n\nNotas: al solicitar el ordenamiento por \"first_availability\", debe enviarse el par谩metro \"speciality_id\" de manera obligatoria.", "tags": [ "medical-centers" ], "parameters": [ { "name": "lat", "in": "query", "description": "Latitud geogr谩fica donde se ubica el paciente", "required": true, "example": "-88.617", "schema": { "type": "string" } }, { "name": "lng", "in": "query", "description": "Longitud geogr谩fica donde se ubica el paciente", "required": true, "example": "-88.410", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "description": "", "required": false, "example": "first_availability", "schema": { "type": "string", "enum": [ "name", "distance", "first_availability" ], "default": "distance" } }, { "name": "speciality_id", "in": "query", "description": "ID asociado a la especialidad a consultar", "required": false, "example": 5, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page", "in": "query", "description": "N煤mero de p谩gina para los resultados.", "required": false, "example": 1, "schema": { "type": "number", "writeOnly": true, "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "medical_centers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado al centro m茅dico" }, "name": { "type": "string", "description": "Nombre del centro m茅dico", "readOnly": true }, "city": { "type": "string", "description": "Ciudad donde est谩 ubicado el centro m茅dico", "readOnly": true }, "lat": { "type": "string", "description": "Latitud geogr谩fica donde se ubica el centro m茅dico" }, "lng": { "type": "string", "description": "Longitud geogr谩fica donde se ubica el centro m茅dico" }, "earliest_available": { "type": "string", "description": "Primera fecha disponible", "nullable": true }, "distance_km": { "type": "string", "description": "Distancia en kilometros desde la posici贸n donde se consult贸 el servicio, hasta los centro m茅dico" } }, "required": [ "id", "name", "city", "lat", "lng", "distance_km" ], "description": "Informaci贸n relacionada al centro m茅dico" }, "description": "Lista con los centros m茅dicos que cumplen los par谩metros solicitados" }, "pagination": { "type": "object", "properties": { "total_medicalCenters": { "type": "integer", "description": "N煤mero de especialidades dentro de la p谩gina consultada ", "minimum": 1, "maximum": 15, "readOnly": true }, "total_pages": { "type": "integer", "minimum": 1, "description": "N煤mero total de p谩ginas posibles de consultar, que cumplen con los par谩metros solicitados" }, "medicalCenters_per_page": { "type": "integer", "description": "N煤mero de especialidades m谩ximas por p谩gina", "const": 15, "readOnly": true } }, "required": [ "total_medicalCenters", "total_pages", "medicalCenters_per_page" ], "description": "Informaci贸n relacionada a la paginaci贸n disponible para los centros m茅dicos que cumplen los par谩metros solicitados" } }, "required": [ "medical_centers", "pagination" ] }, "examples": { "1": { "summary": "Ordenado por cercan铆a", "value": { "medical_centers": [ { "id": 1, "name": "Hospital Italiano de Buenos Aires - Sede Almagro", "city": "CABA", "lat": "-34.607548", "lng": "-58.426964", "distance_km": 1.875 }, { "id": 9, "name": "Hospital de Clinicas Jose de San Martin", "city": "CABA", "lat": "-34.599165", "lng": "-58.397423", "distance_km": 2.293 }, { "id": 7, "name": "Hospital de Pediatria Dr. Juan P. Garrahan", "city": "CABA", "lat": "-34.630819", "lng": "-58.391253", "distance_km": 2.303 }, { "id": 10, "name": "Hospital General de Agudos Dr. Carlos G. Durand", "city": "CABA", "lat": "-34.609431", "lng": "-58.436223", "distance_km": 2.543 }, { "id": 3, "name": "Hospital Britanico de Buenos Aires - Sede Central", "city": "CABA", "lat": "-34.628847", "lng": "-58.383959", "distance_km": 2.723 }, { "id": 8, "name": "Hospital Aleman", "city": "CABA", "lat": "-34.591382", "lng": "-58.401722", "distance_km": 2.948 }, { "id": 2, "name": "Hospital General de Agudos Dr. Juan A. Fernandez", "city": "CABA", "lat": "-34.581236", "lng": "-58.407959", "distance_km": 3.981 }, { "id": 5, "name": "Hospital General de Agudos Dr. Cosme Argerich", "city": "CABA", "lat": "-34.630108", "lng": "-58.365583", "distance_km": 4.318 }, { "id": 12, "name": "Hospital General de Agudos Dr. Teodoro Alvarez", "city": "CABA", "lat": "-34.623887", "lng": "-58.461855", "distance_km": 4.806 }, { "id": 11, "name": "Hospital General de Agudos Parmenio Pi帽ero", "city": "CABA", "lat": "-34.650173", "lng": "-58.453557", "distance_km": 5.43 }, { "id": 6, "name": "Hospital Britanico - Centro Medico Lanus", "city": "Lanus", "lat": "-34.705520", "lng": "-58.391906", "distance_km": 9.981 }, { "id": 4, "name": "Hospital Italiano de Buenos Aires - Sede San Justo", "city": "San Justo", "lat": "-34.681987", "lng": "-58.560678", "distance_km": 15.563 }, { "id": 14, "name": "Hospital El Cruce Dr. Nestor Kirchner", "city": "Florencio Varela", "lat": "-34.794930", "lng": "-58.276223", "distance_km": 23.259 } ], "pagination": { "total_medical_centers": 13, "total_pages": 1, "medical_centers_per_page": 15 } } }, "2": { "summary": "Ordenado por disponibilidad", "value": { "medical_centers": [ { "id": 1, "name": "Hospital Italiano de Buenos Aires - Sede Almagro", "city": "CABA", "lat": "-34.607548", "lng": "-58.426964", "earliest_available": "2026-06-24 04:45:16", "distance_km": 1.875 }, { "id": 9, "name": "Hospital de Clinicas Jose de San Martin", "city": "CABA", "lat": "-34.599165", "lng": "-58.397423", "earliest_available": "2026-06-24 04:45:16", "distance_km": 2.293 }, { "id": 7, "name": "Hospital de Pediatria Dr. Juan P. Garrahan", "city": "CABA", "lat": "-34.630819", "lng": "-58.391253", "earliest_available": "2026-06-24 04:45:16", "distance_km": 2.303 }, { "id": 10, "name": "Hospital General de Agudos Dr. Carlos G. Durand", "city": "CABA", "lat": "-34.609431", "lng": "-58.436223", "earliest_available": "2026-06-24 04:45:16", "distance_km": 2.543 }, { "id": 3, "name": "Hospital Britanico de Buenos Aires - Sede Central", "city": "CABA", "lat": "-34.628847", "lng": "-58.383959", "earliest_available": "2026-06-24 04:45:16", "distance_km": 2.723 }, { "id": 8, "name": "Hospital Aleman", "city": "CABA", "lat": "-34.591382", "lng": "-58.401722", "earliest_available": "2026-06-24 04:45:16", "distance_km": 2.948 }, { "id": 2, "name": "Hospital General de Agudos Dr. Juan A. Fernandez", "city": "CABA", "lat": "-34.581236", "lng": "-58.407959", "earliest_available": "2026-06-24 04:45:16", "distance_km": 3.981 }, { "id": 5, "name": "Hospital General de Agudos Dr. Cosme Argerich", "city": "CABA", "lat": "-34.630108", "lng": "-58.365583", "earliest_available": "2026-06-24 04:45:16", "distance_km": 4.318 }, { "id": 12, "name": "Hospital General de Agudos Dr. Teodoro Alvarez", "city": "CABA", "lat": "-34.623887", "lng": "-58.461855", "earliest_available": "2026-06-24 04:45:16", "distance_km": 4.806 }, { "id": 11, "name": "Hospital General de Agudos Parmenio Pi帽ero", "city": "CABA", "lat": "-34.650173", "lng": "-58.453557", "earliest_available": "2026-06-24 04:45:16", "distance_km": 5.43 }, { "id": 6, "name": "Hospital Britanico - Centro Medico Lanus", "city": "Lanus", "lat": "-34.705520", "lng": "-58.391906", "earliest_available": "2026-06-24 04:45:16", "distance_km": 9.981 }, { "id": 4, "name": "Hospital Italiano de Buenos Aires - Sede San Justo", "city": "San Justo", "lat": "-34.681987", "lng": "-58.560678", "earliest_available": "2026-06-24 04:45:16", "distance_km": 15.563 }, { "id": 14, "name": "Hospital El Cruce Dr. Nestor Kirchner", "city": "Florencio Varela", "lat": "-34.794930", "lng": "-58.276223", "earliest_available": "2026-06-24 04:45:16", "distance_km": 23.259 } ], "pagination": { "total_medical_centers": 13, "total_pages": 1, "medical_centers_per_page": 15 } } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "example": { "error": "Validation error", "details": [ { "field": "query", "message": "speciality_id is required when sort_by=first_availability" } ] } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "NotFoundError", "message": "No medical centers found for the given criteria", "timestamp": "2026-06-24T04:48:05.718Z" } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to retrieve medical centers", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } }, "/medical-centers/1": { "get": { "summary": "/medical-centers/<id>", "deprecated": false, "description": "Permite obtener la informaci贸n de un centro m茅dico seg煤n su ID", "tags": [ "medical-centers" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID asociado al centro m茅dico" }, "name": { "type": "string", "description": "Nombre del centro m茅dico" }, "city": { "type": "string", "description": "Ciudad donde est谩 ubicado el centro m茅dico" }, "lat": { "type": "string", "description": "Latitud geogr谩fica donde se ubica el centro m茅dico" }, "lng": { "type": "string", "description": "Longitud geogr谩fica donde se ubica el centro m茅dico" } }, "required": [ "id", "name", "city", "lat", "lng" ], "description": "Informaci贸n relacionada al centro m茅dico" }, "example": { "id": 1, "name": "Hospital Italiano de Buenos Aires - Sede Almagro", "city": "CABA", "lat": "-34.607548", "lng": "-58.426964" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "example": { "error": "Validation error", "details": [ { "field": "params.id", "message": "id must be a number" } ] } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "NotFoundError", "message": "Medical center id 9999 not found", "timestamp": "2026-06-24T03:19:14.512Z" } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "example": { "error": "InternalServerError", "message": "Failed to retrieve medical center", "timestamp": "2026-04-10T04:08:12.074Z" } } }, "headers": {} } }, "security": [] } } }, "components": { "schemas": {}, "responses": { "ERROR - Not found": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "examples": { "Validacion: el ID de turno NO existe": { "summary": "Validacion: el ID de turno NO existe", "value": { "error": "NotFoundError", "message": "Appointment id 12 not found", "timestamp": "2026-04-10T03:04:19.021Z" } } } } } }, "ERROR - Bad request": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Campo mal utilizado o faltante" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" } }, "required": [ "field", "message" ] }, "description": "Lista de objetos con los campos y sus \nerrores asociados" } }, "required": [ "error", "details" ] }, "examples": { "Ejemplo 1": { "summary": "Ejemplo 1", "value": { "error": "Validation error", "details": [ { "field": "medic_id", "message": "medic_id is required" }, { "field": "patient_id", "message": "patient_id is required" }, { "field": "center_id", "message": "center_id is required" }, { "field": "speciality_id", "message": "speciality_id is required" }, { "field": "starts_at", "message": "starts_at is required" }, { "field": "ends_at", "message": "ends_at is required" } ] } } } } } }, "ERROR - Internal server error": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje asociado al error, asignado por el desarrollador" }, "timestamp": { "type": "string", "description": "Fecha y hora de la petici贸n, con estructura de ISO 8601" } }, "required": [ "error", "message", "timestamp" ] }, "examples": { "Error interno del servidor": { "summary": "Error interno del servidor", "value": { "error": "InternalServerError", "message": "Failed to create appointment", "timestamp": "2026-04-10T04:08:12.074Z" } } } } } }, "Conflicto": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Tipo de error" }, "message": { "type": "string", "description": "Mensaje para guiar hacia la soluci贸n del error" }, "timestamp": { "type": "string", "description": "Fecha y hora de la solicitud", "format": "IS0 8601" }, "01KVFZ8NX30AGWQ6B67M7BRX9Y": { "x-tmp-pending-properties": true } }, "required": [ "error", "message", "timestamp" ] }, "examples": { "Ejemplo 1": { "summary": "Ejemplo 1", "value": { "error": "ConflictError", "message": "Scheduling conflict: the medic already has an overlapping appointment for the given time range", "timestamp": "2026-06-19T12:56:58.262Z" } } } } } } }, "securitySchemes": {} }, "servers": [ { "url": "https://dev.solefrancisco.com/apps2/api/v1", "description": "Entorno desarrollo" }, { "url": "https://test.solefrancisco.com/apps2/api/v1", "description": "Entorno prueba" }, { "url": "https://app.solefrancisco.com/apps2/api/v1", "description": "Entorno producci贸n" } ], "security": [] }
{
"openapi": "3.0.1",
"info": {
"title": "M贸dulo 2 - Gesti贸n de turnos",
"description": "",
"version": "1.0.0"
},
"tags": [
{
"name": "appointments"
},
{
"name": "notifications"
},
{
"name": " specialties"
},
{
"name": "medical-centers"
}
],
"paths": {
"/appointments": {
"post": {
"summary": "/appointments",
"deprecated": false,
"description": "Permite crear turnos en el sistema.\n\nNotas: \n1) El valor de la propiedad \"starts_at\" debe ser mayor al instante actual.\n2) La hora del valor de la propiedad \"starts_at\" debe ser entre las 09:00 y las 17:30.\n3) El valor de la propiedad \"ends_at\" no debe superar los 30 minutos exactos en relaci贸n a la propiedad \"starts_at\".\n4) La hora del valor de la propiedad \"ends_at\" debe ser entre las 09:30 y las 18:00.\n5) El valor de la propiedad \"ends_at\" no debe ser anterior al de \"starts_at\".\n6) El valor de la propiedad \"medic_id\" debe ser distinto a \"patient_id\" y viceversa, debido a que si bien son distintos roles ambos son usuarios.\n7) Ejecutar este servicio enviar谩 un mail al paciente y al m茅dico informando sobre la creaci贸n del turno.",
"tags": [
"appointments"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"medic_id": {
"type": "integer",
"description": "ID de usuario asociado al m茅dico del turno",
"minimum": 1
},
"patient_id": {
"type": "integer",
"description": "ID de usuario asociado al paciente del turno",
"minimum": 1
},
"center_id": {
"type": "integer",
"description": "ID asociado al centro m茅dico donde se llevar谩 a cabo el turno",
"minimum": 1
},
"speciality_id": {
"type": "integer",
"description": "ID asociado a la especialidad del m茅dico que el paciente necesitaba",
"minimum": 1
},
"starts_at": {
"type": "string",
"description": "Fecha y hora del inicio del turno",
"format": "YYYY-MM-DD HH:mm:ss"
},
"ends_at": {
"type": "string",
"description": "Fecha y hora estipulada de fin del turno",
"format": "YYYY-MM-DD HH:mm:ss"
}
},
"required": [
"medic_id",
"patient_id",
"center_id",
"speciality_id",
"starts_at",
"ends_at"
]
},
"examples": {
"1": {
"value": {
"medic": {
"id": 1361561151,
"fullname": "Dr. Juan P茅rez",
"email": "juan.perez@test.com"
},
"patient": {
"id": 3365611,
"fullname": "martin fernandes",
"email": "martin@test.com"
},
"appointment": {
"center_id": 2,
"speciality_id": 107,
"starts_at": "2026-09-29 12:00:00",
"ends_at": "2026-09-29 12:30:00"
}
},
"summary": "[201] Petici贸n correcta"
},
"2": {