Saltar al contenido principal

[Preview] Listar servicios contratados

GET/contracted-services

Lista servicios activos del contrato indicado para la fecha consultada. La respuesta es paginada y no expone tarifas, identificadores de otros tenants ni datos del paciente. Preview respaldado solo por catalogos internos de pagadores y contratos.

curl --request GET \
  --url '${BASE_URL}/contracted-services' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000005' \
  --data-urlencode 'payerId=30000000-0000-4000-8000-000000000001' \
  --data-urlencode 'contractId=30000000-0000-4000-8000-000000000002' \
  --data-urlencode 'effectiveOn=2026-08-03'

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.
`payerId`	query	Si	Identificador del pagador en el tenant.
`contractId`	query	Si	Contrato activo asociado al pagador.
`effectiveOn`	query	Si	Fecha local para validar vigencia.
`cursor`	query	No	Cursor opaco retornado por la pagina anterior; no debe interpretarse.
`limit`	query	No	Cantidad maxima de elementos solicitados.

Responses

200Pagina de servicios contratados vigentes.

Content-Type: application/json

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

Ejemplo

{
  "items": [
    {
      "appointmentTypeId": "30000000-0000-4000-8000-000000000004",
      "code": "CONSULTA-GENERAL",
      "id": "30000000-0000-4000-8000-000000000003",
      "name": "Consulta medicina general",
      "requiresPreauthorization": false
    }
  ],
  "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"
}

404Recurso inexistente o no visible dentro del tenant autenticado.

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": "RESOURCE_NOT_FOUND",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 404,
  "title": "Recurso no encontrado",
  "type": "https://magnosoft.com.co/problems/not-found"
}

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