Saltar al contenido principal

Consultar opciones de disponibilidad

GET/availability

Retorna opciones reservables para un servicio y rango maximo de 31 dias. optionToken es opaco, ligado al tenant y de corta duracion; debe enviarse al reservar y no debe persistirse como identificador de agenda.

curl --request GET \
  --url '${BASE_URL}/availability' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000006' \
  --data-urlencode 'serviceId=30000000-0000-4000-8000-000000000003' \
  --data-urlencode 'from=2026-08-03T00:00:00-05:00' \
  --data-urlencode 'to=2026-08-10T00:00:00-05:00'

Request

Headers y parametros

Nombre	Ubicacion	Requerido	Descripcion
`X-Correlation-Id`	header	No	UUID generado por el consumidor para trazabilidad; el servidor genera uno si se omite.
`serviceId`	query	Si	Servicio contratado solicitado.
`from`	query	Si	Inicio inclusivo en ISO 8601 con offset.
`to`	query	Si	Fin exclusivo en ISO 8601 con offset.
`locationId`	query	No	Filtro opcional por sede.
`practitionerId`	query	No	Filtro opcional por profesional.
`cursor`	query	No	Cursor opaco retornado por la pagina anterior; no debe interpretarse.
`limit`	query	No	Cantidad maxima de elementos solicitados.

Responses

200Pagina de opciones disponibles al momento de la consulta.

Content-Type: application/json

Campo	Tipo	Requerido	Descripcion
`items`	`object[]`	Si	-
`nextCursor`	`string \| null`	Si	-

Ejemplo

{
  "items": [
    {
      "endsAt": "2026-08-03T09:30:00-05:00",
      "expiresAt": "2026-07-26T14:20:00-05:00",
      "locationId": "50000000-0000-4000-8000-000000000001",
      "optionToken": "opt_preview_synthetic_not_a_real_token",
      "practitionerId": "50000000-0000-4000-8000-000000000002",
      "startsAt": "2026-08-03T09:00:00-05:00"
    }
  ],
  "nextCursor": null
}

400Solicitud mal formada o parametro invalido.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "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

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "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

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "INSUFFICIENT_SCOPE",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 403,
  "title": "Permiso insuficiente",
  "type": "https://magnosoft.com.co/problems/forbidden"
}

422JSON valido que incumple una regla de validacion del contrato.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "VALIDATION_FAILED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "errors": [
    {
      "code": "INVALID_DATE",
      "field": "serviceDate",
      "message": "Debe ser una fecha ISO 8601 valida."
    }
  ],
  "status": 422,
  "title": "Validacion fallida",
  "type": "https://magnosoft.com.co/problems/validation"
}

429Limite de solicitudes excedido para el service principal.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

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