Grupos

Obtener grupos

Obtener información del nivel de los grupos

Request

query Parameters

section_id	Array of strings Filtrar por `section_id`. Este filtro es de tipo array, la forma de usarlo es la siguiente: `/?section_id=VGQX6FE7&section_id=EDFRET4G`
level_id	Array of strings Filtrar por `level_id`. Este filtro es de tipo array, la forma de usarlo es la siguiente: `/?level_id=VGQX6FE7&level_id=EDFRET4G`

header Parameters

algebraix-api-token required	string = 32 characters ALGEBRAIX API KEY Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode	boolean Default: false La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema NOTA: La instancia se crea desde web.

Responses

200

No error

400

Bad parameters

401

Authorization Required

get/groups

Request samples

Response samples

application/json

[{"id": "BTG236IA",
"is_active": true,
"name": "01-PRIMER_GRUPO",
"description": "Primer grupo",
"curriculum": {"id": "FGREDFR4",
"name": "plan-de-estudio-01"
},
"campus": {"id": "3XBSOSFL",
"name": "campus01"
},
"section": {"id": "GCNHYUJA",
"name": "seccion01"
},
"level": {"id": "MNHJ34FD",
"name": "grado01"
},
"teacher": {"id": "LASDWE23",
"name": "profesor01",
"lastname": "apellido01 apellido02"
},
"social_service_hours": 10,
"has_attendance": false,
"tardy_absence_equivalence": 9999,
"use_timeclock": false,
"has_activity_reports": false,
"additional_info": ["additional_info_1",
"additional_info-2",
"additional_info_3"
],
"tuition": {"amount": "2500.00",
"tax_percentage": "EXEMPT"
},
"series": {"id": "TEMPTEMP",
"name": "TEMPTEMP"
},
"identifier": {"service_code": "ZSXCDFVG",
"contra_service_code": "XSDCFRTG",
"tax_service_code": "VFGBRTGF",
"contra_tax_service_code": "QWXZASWE"
},
"templates": {"gradebooks_id": "DEFAULT1",
"bank_code_id": "DEFAULT2"
}
}
]

Obtener clases

Obtener las clases del grupo y su configuración

Request

path Parameters

group_id

required

string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del grupo

Puedes encontrar más información sobre cómo obtenerlo en la documentación de Grupos

Example: ASWDERF4

query Parameters

limit	integer [ 1 .. 100 ] Default: 100 Límite de clases
page	integer >= 1 Default: 1 Número de página de consulta

header Parameters

algebraix-api-token required	string = 32 characters ALGEBRAIX API KEY Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode	boolean Default: false La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema NOTA: La instancia se crea desde web.

Responses

200

No error

400

Bad parameters

401

Authorization Required

get/groups/{group_id}/classes

Request samples

Response samples

application/json

[{"id": "ASEDFE3R",
"definition_id": "FGR45RED",
"is_active": true,
"name": "18-disciplina",
"description": "",
"has_attendance": true,
"has_automatic_enrollments": true,
"has_chatroom": false,
"has_extra_credits": true,
"has_fail_recovery": true,
"has_forums": false,
"has_library": false,
"has_resits": true,
"has_schedule": true,
"has_show_criteria_grades": false,
"has_show_details_to_students": true,
"has_hide_criteria_percentage": false,
"has_extra_credit_info_is_public": false,
"has_average_missing_grades": true,
"has_teacher_can_edit_limit_grade": false,
"has_variable_period_percentage": false,
"has_grade_criteria": false,
"has_timeclock": false,
"hours": 1,
"is_gradeable": true,
"online_session_link": "",
"automatic_fail_grade": "5.00",
"maximum_cycle_absences": 9999,
"maximum_period_absences": 9999,
"maximum_subcycle_absences": 9999,
"minimum_cycle_possible_grade": "5.00",
"minimum_passing_grade": "6.00",
"minimum_period_possible_grade": "5.00",
"minimum_subcycle_possible_grade": "5.00",
"tardy_absence_equivalence": 9999,
"color": "#99CCFF",
"credits": "0.00",
"default_schedule_span": 5,
"conversion_code": "GPA",
"equivalence_type": "PERIOD",
"additional_info": [ ],
"campus": {"id": "EFEW23ER",
"name": "campus01"
},
"curriculum": {"id": "QWED2WER",
"name": "plan-de-estudio-1"
},
"level": {"id": "JUYTTRFG",
"name": "01 - PRIMERO"
},
"section": {"id": "XCDSEFRT",
"name": "seccion01"
},
"type": {"id": "00000100",
"name": "Artes"
},
"secondary_teacher": {"id": "RETYGRE3",
"name": "auxiliar01",
"lastname": "apellido01 materno01"
},
"teacher": {"id": "LMKJHT4E",
"name": "profesor01",
"lastname": "apellido01 materno01"
},
"average_method": {"name": "",
"period_div_name": "",
"use": false
},
"rounding": {"cycle": {"approved": {"rounding": "CUT"
},
"failed": {"rounding": "CUT",
"value": "0.000"
}
},
"period": {"approved": {"rounding": "CUT"
},
"failed": {"rounding": "CUT",
"value": "0.000"
}
},
"subcycle": {"approved": {"rounding": "CUT"
},
"failed": {"rounding": "CUT",
"value": "0.000"
}
}
}
}
]

Obtener categorias

Obtener las categorias de un grupo filtrando por ciclo, subciclo o periodo

Request

path Parameters

group_id

required

string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del grupo

Example: ASWDERF4

query Parameters

type

required

string

Propiedad de busqueda

Enum Value	Description
CYCLE	Ciclos
SUBCYCLE	Subciclos
PERIOD	Periodos

required

string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del ciclo, subciclo o periodo

Puedes encontrar más información sobre cómo obtenerlo en la documentación de Ciclos
Puedes encontrar más información sobre cómo obtenerlo en la documentación de Subciclos
Puedes encontrar más información sobre cómo obtenerlo en la documentación de Periodos

Example: id=WADFERF3

is_attendance_category

boolean

Default: true

Es categoria de asistencias

header Parameters

algebraix-api-token required	string = 32 characters ALGEBRAIX API KEY Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode	boolean Default: false La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema NOTA: La instancia se crea desde web.

Responses

200

No error

400

Bad parameters

401

Authorization Required

get/groups/{group_id}/categories

Request samples

Response samples

application/json

[{"id": "ASEDFE3R",
"name": "Asignaturas SEP",
"weight": 9000
}
]

Obtener clases virtuales

Obtener las clases virtuales y su configuración

Request

path Parameters

group_id

required

string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del grupo

Example: ASWDERF4

header Parameters

algebraix-api-token required	string = 32 characters ALGEBRAIX API KEY Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode	boolean Default: false La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema NOTA: La instancia se crea desde web.

Responses

200

No error

400

Bad parameters

401

Authorization Required

get/groups/{group_id}/virtual_classes

Request samples

Response samples

application/json

[{"id": "ASEDFE3R",
"is_active": true,
"name": "18-disciplina",
"description": "",
"has_attendance": true,
"has_automatic_enrollments": true,
"has_fail_recovery": true,
"has_resits": true,
"has_average_missing_grades": true,
"has_variable_period_percentage": false,
"hours": 1,
"automatic_fail_grade": "5.00",
"maximum_cycle_absences": 9999,
"maximum_period_absences": 9999,
"maximum_subcycle_absences": 9999,
"minimum_cycle_possible_grade": "5.00",
"minimum_passing_grade": "6.00",
"minimum_period_possible_grade": "5.00",
"minimum_subcycle_possible_grade": "5.00",
"tardy_absence_equivalence": 9999,
"color": "#99CCFF",
"credits": "0.00",
"conversion_code": "GPA",
"equivalence_type": "PERIOD",
"additional_info": [ ],
"campus": {"id": "EFEW23ER",
"name": "campus01"
},
"curriculum": {"id": "QWED2WER",
"name": "plan-de-estudio-1"
},
"level": {"id": "JUYTTRFG",
"name": "01 - PRIMERO"
},
"section": {"id": "XCDSEFRT",
"name": "seccion01"
},
"type": {"id": "00000100",
"name": "Artes"
},
"rounding": {"cycle": {"approved": {"rounding": "CUT"
},
"failed": {"rounding": "CUT",
"value": "0.000"
}
},
"period": {"approved": {"rounding": "CUT"
},
"failed": {"rounding": "CUT",
"value": "0.000"
}
},
"subcycle": {"approved": {"rounding": "CUT"
},
"failed": {"rounding": "CUT",
"value": "0.000"
}
}
}
}
]

Obtener horario de la clase

Obtener horario de un grupo en específico

Request

path Parameters

group_id required	string (id) = 8 characters ^[A-Z0-9]{8}$ Identificador único del grupo Example: ASWDERF4
class_id required	string (id) = 8 characters ^[A-Z0-9]{8}$ Identificador único del grupo Example: ASWDERF4

header Parameters

algebraix-api-token required	string = 32 characters ALGEBRAIX API KEY Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode	boolean Default: false La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema NOTA: La instancia se crea desde web.

Responses

200

No error

400

Bad parameters

401

Authorization Required

get/groups/{group_id}/classes/{class_id}/schedule

Request samples

Response samples

application/json

[{"monday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"tuesday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"wednesday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"thursday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"friday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "11:00",
"end": "12:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"saturday": [ ],
"sunday": [ ]
}
]

Obtener horario del grupo

Obtener el horario del grupo

Request

path Parameters

group_id

required

string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del grupo

Example: ASWDERF4

header Parameters

algebraix-api-token required	string = 32 characters ALGEBRAIX API KEY Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode	boolean Default: false La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema NOTA: La instancia se crea desde web.

Responses

200

No error

400

Bad parameters

401

Authorization Required

get/groups/{group_id}/schedule

Request samples

Response samples

application/json

[{"monday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"tuesday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"wednesday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"thursday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "10:00",
"end": "11:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"friday": [{"id": "WEDFERT4",
"class": {"id": "DFEWXCDS",
"definition_id": "GBVVFGRT",
"name": "18-disciplina"
},
"classroom": {"id": "QASWEDV1",
"name": "aula01"
},
"time": {"start": "11:00",
"end": "12:00"
},
"online_session_link": "",
"has_attendance": false,
"color": "#FFCC66"
}
],
"saturday": [ ],
"sunday": [ ]
}
]

➔ Next to Ciclos