Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ttpullima/RomsoftBackEnd2021_v2/llms.txt

Use this file to discover all available pages before exploring further.

Medical specialties are a foundational catalog in the Gestión Clínica system. Every consultation, appointment, and care pathway is associated with a specialty — such as Cardiología, Pediatría, or Traumatología — and each specialty can be linked to one or more healthcare professionals. The ADM_ESPECIALIDAD controller exposes two endpoints: one to list all currently active specialties system-wide, and another to look up only the specialties associated with a specific professional. All endpoints require a valid Authorization bearer token obtained from the authentication service.
All ADM_ESPECIALIDAD endpoints are HTTP POST. The API follows a convention where all operations use POST, with filter criteria passed in the request body rather than as query parameters.

​
Data Transfer Objects

​
ADM_ESPECIALIDADDTO

Represents a medical specialty record returned from the API. Extends EntityAuditableDTO, which adds audit trail fields.
​
id_especialidad
integer
Unique surrogate key for the specialty record.
​
c_codigo
string
Short alphanumeric code identifying the specialty (e.g., "CARD", "PED").
​
t_descripcion
string
Full human-readable name of the specialty (e.g., "Cardiología", "Pediatría").
​
FechaCreacion
string | null
ISO 8601 timestamp of when the record was created. Inherited from EntityAuditableDTO.
​
FechaModificacion
string | null
ISO 8601 timestamp of the last modification. Inherited from EntityAuditableDTO.
​
UsuarioCreacion
string
Username of the operator who created the record. Inherited from EntityAuditableDTO.
​
UsuarioModificacion
string
Username of the last operator who modified the record. Inherited from EntityAuditableDTO.
​
id_usuarioCreacion
integer
Numeric ID of the creating user. Inherited from EntityAuditableDTO.
​
id_usuarioModifica
integer
Numeric ID of the modifying user. Inherited from EntityAuditableDTO.
​
IdUsuarioActual
integer
Numeric ID of the currently authenticated user performing the operation. Inherited from EntityAuditableDTO.

​
ADM_ESPECIALIDADPROFESIONALDTO

A lightweight filter object used to look up specialties for a given professional. Sent as the request body to GetEspecialidadProfesionalById.
​
id_profesional
integer
required
The unique identifier of the healthcare professional whose assigned specialties should be retrieved.

​
Specialty ↔ Professional Relationship

Each healthcare professional registered in the system may be assigned to one or more medical specialties. This many-to-many relationship is navigated through GetEspecialidadProfesionalById: the caller supplies a professional’s id_profesional, and the API returns all ADM_ESPECIALIDADDTO records associated with that individual. This list is typically consumed by scheduling and appointment modules to present only the relevant specialties when booking a consult for a specific doctor.
Use GetAllActives to populate a general specialty picker (e.g., on a patient-facing booking form), and use GetEspecialidadProfesionalById when the user has already selected a specific professional and you need to constrain the specialty dropdown to that doctor’s qualifications.

​
Endpoints

​
POST /api/ADM_ESPECIALIDAD/GetAllActives

Returns the complete list of active medical specialties registered in the system. No request body is required. Request 
curl -s -X POST \
  https://{base_url}/api/ADM_ESPECIALIDAD/GetAllActives \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"
Response — success 
{
  "Success": true,
  "Data": [
    {
      "id_especialidad": 1,
      "c_codigo": "MG",
      "t_descripcion": "Medicina General",
      "FechaCreacion": "2021-01-10T08:00:00",
      "FechaModificacion": null,
      "UsuarioCreacion": "admin",
      "UsuarioModificacion": null,
      "id_usuarioCreacion": 1,
      "id_usuarioModifica": 0,
      "IdUsuarioActual": 0
    },
    {
      "id_especialidad": 2,
      "c_codigo": "CARD",
      "t_descripcion": "Cardiología",
      "FechaCreacion": "2021-01-10T08:00:00",
      "FechaModificacion": null,
      "UsuarioCreacion": "admin",
      "UsuarioModificacion": null,
      "id_usuarioCreacion": 1,
      "id_usuarioModifica": 0,
      "IdUsuarioActual": 0
    }
  ],
  "Message": null,
  "Warning": false
}
Response — error 
{
  "Success": false,
  "Data": null,
  "Message": "Ocurrió un error, inténtelo más tarde.",
  "Warning": false
}

​
POST /api/ADM_ESPECIALIDAD/GetEspecialidadProfesionalById

Returns all active specialties associated with a specific healthcare professional. Pass an ADM_ESPECIALIDADPROFESIONALDTO object as the request body. Request body
​
id_profesional
integer
required
Numeric identifier of the professional. Must correspond to an existing record in ADM_PROFESIONAL.
Request 
curl -s -X POST \
  https://{base_url}/api/ADM_ESPECIALIDAD/GetEspecialidadProfesionalById \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"id_profesional": 7}'
Response — success 
{
  "Success": true,
  "Data": [
    {
      "id_especialidad": 3,
      "c_codigo": "PED",
      "t_descripcion": "Pediatría",
      "FechaCreacion": "2021-03-15T09:30:00",
      "FechaModificacion": null,
      "UsuarioCreacion": "admin",
      "UsuarioModificacion": null,
      "id_usuarioCreacion": 1,
      "id_usuarioModifica": 0,
      "IdUsuarioActual": 0
    }
  ],
  "Message": null,
  "Warning": false
}
Response — professional has no specialties / not found 
{
  "Success": true,
  "Data": null,
  "Message": "La especialidad no existe.",
  "Warning": true
}
When a professional exists but has no specialty assignments, or when id_profesional does not match any record, the response returns Success: true with Warning: true and a descriptive message rather than a 4xx HTTP error.

​
Response Envelope

All endpoints return a uniform JsonResponse envelope:
FieldTypeDescription
Successbooleantrue if the request was processed without a server-side exception.
Dataarray / nullThe payload — an array of ADM_ESPECIALIDADDTO objects on success.
Messagestring / nullHuman-readable message, populated on warning or error states.
Warningbooleantrue when the operation succeeded but produced a business-rule warning.

Build docs developers (and LLMs) love

Get started for freeTalk to us