Complementos
Listar Complementos
Ofrece la lista de todos los programas académicos disponibles en las escuelas y campus.
get/complements
Query parameters
program_idstring required
Parametro requerido para consultar las inscripciones de un programa
qstring
Parámetro para realizar búsquedas basadas en key y value de los datos o dentro del metadata usando metadata.key=value. Los criterios de búsqueda disponibles son:
- name
- date_from
- date_to
- page
- status
- external_id
- metadata Puedes proporcionar múltiples criterios separados por espacio. Ejemplo: external_id=123456 metadata.student_curp=12345
Headers
campusIDstring uuid required
ID del Campus que se desea trabajar.
periodIDstring uuid required
ID del periodo que se desea trabajar.
Response
Listar Complementos
Example response
{
"items": {
"items": 112,
"page": 1,
"total_pages": 11
},
"data": [
{
"id": "cpt_96adb1f0-0874-4b8d-be9e-4f8772388d33",
"program_id": "prm_0cb0b357-b55c-4daa-938e-47733305a4fc",
"name": "Complemento curso natación",
"amount": 1000,
"frecuency": "unique",
"periodicity": "monthly",
"start_date": "2024-01-01",
"end_date": "2024-06-30",
"external_id": "a2745b9f-64eb-419e-8f18-7913d08d102f",
"metadata": {
"id_alumno": "123abc"
},
"items": [
{
"pay_date": "2024-01-10"
}
]
}
]
}