Saltar al contenido principal

Listar profesionales reservables

GET/practitioners

Lista profesionales activos del tenant autenticado. Puede filtrar por servicio y sede; los arreglos retornados contienen exclusivamente relaciones activas utilizables por SAH.

curl --request GET \
  --url '${BASE_URL}/practitioners' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --data-urlencode 'serviceId=22000000-0000-4000-8000-000000000004'

Request

Headers y parametros

NombreUbicacionRequeridoDescripcion
X-Correlation-IdheaderNoUUID generado por el consumidor para trazabilidad; el servidor genera uno si se omite.
serviceIdqueryNoTipo de cita contratado que debe atender el profesional.
locationIdqueryNoSede activa asociada al profesional.
cursorqueryNoCursor opaco retornado por la pagina anterior; no debe interpretarse.
limitqueryNoCantidad maxima de elementos solicitados.

Responses

200Pagina estable de profesionales reservables.

Content-Type: application/json

CampoTipoRequeridoDescripcion
itemsobject[]Si-
nextCursorstring | nullSi-

Ejemplo

ejemplo de respuesta 200
{
  "items": [
    {
      "code": "ANA-TORRES",
      "fullName": "Dra. Ana Torres",
      "id": "22000000-0000-4000-8000-000000000002",
      "locationIds": [
        "22000000-0000-4000-8000-000000000001"
      ],
      "serviceIds": [
        "22000000-0000-4000-8000-000000000004"
      ],
      "specialtyIds": [
        "22000000-0000-4000-8000-000000000003"
      ]
    }
  ],
  "nextCursor": null
}
400Solicitud mal formada o parametro invalido.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 400
{
  "code": "INVALID_REQUEST",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "detail": "Revise los parametros enviados.",
  "status": 400,
  "title": "Solicitud invalida",
  "type": "https://magnosoft.com.co/problems/invalid-request"
}
401Token ausente, invalido, vencido o con audience incorrecta.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 401
{
  "code": "INVALID_ACCESS_TOKEN",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 401,
  "title": "Autenticacion requerida",
  "type": "https://magnosoft.com.co/problems/unauthorized"
}
403Service principal autenticado sin el scope requerido.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 403
{
  "code": "INSUFFICIENT_SCOPE",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 403,
  "title": "Permiso insuficiente",
  "type": "https://magnosoft.com.co/problems/forbidden"
}
429Limite de solicitudes excedido para el service principal.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 429
{
  "code": "RATE_LIMIT_EXCEEDED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 429,
  "title": "Demasiadas solicitudes",
  "type": "https://magnosoft.com.co/problems/rate-limit"
}