Download OpenAPI specification:
Eficaz Webservice permite la gestión y control de instituciones escolares
Crear un padre que al inicio puede no ser un trabajador de una escuela
Datos necesarios para crear un usuario
| enrollment | string <= 50 characters Folio del usuario usando dentro de su centro de trabajo |
| name required | string <= 50 characters Nombre del usuario |
| last_name required | string <= 50 characters Apellido paterno |
| second_last_name | string <= 50 characters Apellido materno |
string <email> <= 50 characters Correo electrónico | |
| cellphone required | string <= 10 characters Número de celular |
| colony required | string <= 50 characters Colonia |
| inside_number | string <= 20 characters Número interior |
| outside_number required | string <= 20 characters Número exterior |
| street required | string <= 50 characters Calle |
| zipcode required | string <= 5 characters Código postal |
| city_id | integer Identificador de la ciudad de domicilio |
| birth_city_id | integer Identificador de la ciudad de nacimiento |
| level_education | integer Nivel máximo de estudio |
| curp | string <= 18 characters CURP |
| rfc | string <= 13 characters RFC |
| date_birth | string <date> Fecha de nacimiento |
| gender | integer Genero |
| is_trained | boolean Define si el usuario ya ha sido capacitado |
| is_stranger | boolean Define si el usuario es extranjero |
| is_foreign | boolean Define si el usuario es foraneo |
| is_immigrant | boolean Define si el usuario es inmigrante |
| is_indigenous | boolean Define si el usuario es indígena |
| user_id | integer Identificador del usuario |
| credential_id | integer Identificador de la credencial de acceso |
| school_id | integer Deprecated Identificador de la escuela donde se trabaja |
| has_smartphone | boolean Define si el usuario tiene un teléfono celular |
| send_sms | boolean Define si el usuario es capas de recibir mensajes SMS |
| country_code | string Código telefónico del país |
| group_id | string Deprecated Define los roles soportados por el usuario |
| created_by | integer Identificador del usuario, quien fue el creador del nuevo usuario |
| updated_at | string <date-time> Fecha cuando fue creado el usuario |
| created_at | string <date-time> Fecha cuando fue actualizado el usuario |
| url_photo_profile | string URL de la imagen de perfil |
| status | number Estado del usuario |
| push_id | string Identificador del Servicio de OneSignal |
| push_token | string Token del Servicio de OneSignal |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Crear un administrador que aun no cuenta con una escuela para administrar
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Registra un nuevo profesor que podra dar clases en algún grupo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Registra un nuevo asesor que podra gestionar los reportes de un grupo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Registra un nuevo vosero que podra enviar avisos a todos los usuarios de eficaz
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Registra un nuevo administrador que podra gestionar las operaciones de una escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Registra un nuevo padre que podra ser gestionado por la escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Registra un nuevo director que podra observar las estadisticas de la escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Registra y asigna un nuevo alumno a un grupo
| schoolId required | integer Identificador de la escuela |
| groupId required | integer Identificador del grupo |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Registra un nuevo alumno listo para ser asignado a un grupo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Nombrar asistencia a un solo alumno
| studentId required | integer Identificador del alumno |
| subjectId required | integer Identificador de la materia |
{- "data": {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Registra un bloque de asistencias
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Captura una calificación a un solo alumno
| studentId required | integer Identificador del alumno |
| subjectId required | integer Identificador de la materia |
{- "data": {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Registra un bloque de asistencias
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Comprueba si hay actualizaciones disponibles para la aplicación movil
| operatingSystem required | string Nombre del sistema Operativo |
| platform required | string Nombre del la plataforma |
| osVersion required | string Version del sistema operativo |
| isVirtual required | boolean Define si la aplicacion se esta ejecutando en un entorno virtual |
| version required | string Version actual de la aplicacion |
| enviroment required | string Entorno de compilacion del webservice |
| model required | string Modelo del dispositivo |
| user | integer or null Identificador del usuario logeado |
{- "allow": true,
- "message": "string",
- "improved": [
- {
- "label": "string",
- "icon": "string"
}
]
}Comprueba la contraseña enviada contra el usuario autenticado con el OAuth token, usado cuando se quiere realizar una acción importante en el sistema
| password required | string Contraseña a verificar |
{- "message": "Contraseña incorrecta",
- "status": "409",
- "code": "3753"
}Retorna la informacion personal del usuario perteneciente al token que se esta enviado
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Retorna una lista de licencias perteneciente al token que se esta enviado
{- "data": [
- {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de notificaciones que han sido enviadas por el sistema al usuario autenticado
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Recupera un listado de noticias que han sido enviadas por el sistema al usuario autenticado
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los parciales disponibles
{- "data": [
- {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el parcial con el identificador envido por parametro
| partialId required | integer Identificador del parcial |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos del parcial con el identificador enviado por parametro
| partialId required | integer Identificador del parcial |
| partial required | integer Número del parcial |
| level required | integer Enum: 1 2 3 4 5 Nivel escolar del parcial |
| start_date | string <date-time> Fecha de inicio del parcial |
| end_date | string <date-time> Fecha de fin del parcial |
| limit_date | string <date-time> Fecha limite del parcial |
| is_regularized required | integer Enum: 0 1 Define si el parcial es de regularización |
| is_final | boolean Enum: 0 1 Define si el parcial es para calificación final |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un parcial
| partialId required | integer Identificador del parcial |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la escuela del parcial
| partialId required | integer Identificador del parcial |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas las calificacaiones del parcial
| partialId required | integer Identificador del parcial |
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra muestra todas las asistencias del parcial
| partialId required | integer Identificador del parcial |
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un listado de validaciones sobre las calificaciones que fueron creadas dentro del parcial enviado por parametro
| partialId required | integer Identificador del parcial |
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una validación que autoriza el uso fiable de la calificaciones
| partialId required | integer Identificador del parcial |
| validation_level required | integer Nivel escolar de validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los administrativos del sistema
{- "data": [
- {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un administrativos en especifico
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Actualiza todas las propiedades de un administrativos
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Eliminar un administrativos
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra la escuela a la pertenece
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el listado de licecias de usuario pueden operar en la escuela identificado en la ruta
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una licencia de trabajo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el listado de rastreos de alumnos de la escuela enviada en la ruta
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad donde esta ubicada la escuela identificado en la ruta
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna uns lista de documentos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las valdiaciones de parciales de la escuela enviad por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las importaciones de la escuela enviad por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra una lista de idiomas habladas por el alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agregar un idioma al alumno envido por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina la relacion de un idioma con un alumno
| studentId required | integer Identificador del alumno |
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de caracteristica que describen al alumno enviado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una relacion de un alumno con una caracteristica
| studentId required | integer Identificador del alumno |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina la relacion de una caracteristica con un alumno
| studentId required | integer Identificador del alumno |
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de los documentos adjuntos al alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un documento al alumno envido por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de las redes sociales pertenecientes al alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agregar una red social al alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el rastreo a traves varias escuelas del alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad de nacimiento del alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra las materias que se imparten en ese grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un listado de validaciones sobre las calificaciones que fueron creadas dentro del parcial enviado por parametro
| partialId required | integer Identificador del parcial |
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una validación que autoriza el uso fiable de la calificaciones
| partialId required | integer Identificador del parcial |
| validation_level required | integer Nivel escolar de validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de lenjuages e idiomas
{- "data": [
- {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Permite crear un nuevo idoma
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la informaicon del lenguaje enviado por parametro
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modifica los valores de un lenguaje
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar el lenjuage enviado por parametro
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de alumnos que hablan el idioma enviado por parametro
| languageId required | integer Identificador del lenguaje |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de validaciones de calificaciones
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informaicon de la validación enviado por parametro
| validationId required | integer Identificador de la validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Permite actualizar los datos de una validación
| validationId required | integer Identificador de la validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una validación
| validationId required | integer Identificador de la validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el parcial asociado a la validación enviada por parametro
| validationId required | integer Identificador de la validación |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el usuario que creo la validación enviada por parametro
| validationId required | integer Identificador de la validación |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Retorna un listado de calificaciones validadas por identificador enviada por parametro
| validationId required | integer Identificador de la validación |
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de caracteristicas de alumnos
{- "data": [
- {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un caracteristica
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la informaicon de la caracteristica enviado por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de la caracteristica enviada por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina la caracteristica enviada por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de alumnos con la caracteristica enviado por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de documentos del alumnos
{- "data": [
- {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del documento enviado por parametro
| documentId required | integer Identificador de un documento |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualizar los datos de un documento
| documentId required | integer Identificador de un documento |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualizar un documento
| documentId required | integer Identificador de un documento |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el alumno asociado al documento enviado por parametro
| documentId required | integer Identificador de un documento |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de redes sociales del alumnos
{- "data": [
- {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de la red social enviada por parametro
| socialmediaId required | integer Identificador de la red social |
{- "data": {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualziar los datos de una red social
| socialmediaId required | integer Identificador de la red social |
{- "data": {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una red social
| socialmediaId required | integer Identificador de la red social |
{- "data": {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el alumno asociado a la red social enviada por parametro
| socialmediaId required | integer Identificador de la red social |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de licencias de trabajo
{- "data": [
- {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de la licencia enviada por parametro
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de una licencia
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una licencia
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la escuela asociada a la licencia enviado por parametro
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el usuario asociado a la licencia enviado por parametro
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Retorna una lista de rastros que los alumnos van dejando
{- "data": [
- {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del rastro enviado por parametro
| traceId required | integer Identificador de rastro |
{- "data": {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de un rastreo
| traceId required | integer Identificador de rastro |
{- "data": {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un rastreo
| traceId required | integer Identificador de rastro |
{- "data": {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el alumno asociado al rastreo enviado por parametro
| traceId required | integer Identificador de rastro |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la escuela asociada al rastreo enviado por parametro
| traceId required | integer Identificador de rastro |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de estados
{- "data": [
- {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del estado enviado por parametro
| stateId required | integer Identificador del estado |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de un estado
| stateId required | integer Identificador del estado |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un estado
| stateId required | integer Identificador del estado |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de paises
{- "data": [
- {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del pais enviado por parametro
| countryId required | integer Identificador del pais |
{- "data": {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualizar los datos de un pais
| countryId required | integer Identificador del pais |
{- "data": {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualziar los datos de un pais
| countryId required | integer Identificador del pais |
{- "data": {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de estados que pertenecen al pais enviado por parametro
| countryId required | integer Identificador del pais |
{- "data": [
- {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de municipios
{- "data": [
- {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del municipio enviado por parametro
| municipalityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos del municipio
| municipalityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un municipio
| municipalityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el estado al que pertenece el minicipio enviado por parametro
| municipalityId required | integer Identificador del pais |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la lista de ciudades que pertenecen al minicipio enviado por parametro
| municipalityId required | integer Identificador del pais |
{- "data": [
- {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de ciudades
{- "data": [
- {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de la ciudad enviado por parametro
| cityId required | integer Identificador del pais |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de la clidad
| cityId required | integer Identificador del pais |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar una ciudad
| cityId required | integer Identificador del pais |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el municipio al que pertenecen la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el listado de alumnos que viven la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el listado de usuarios que viven la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": [
- {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el listado de escuelas que estan ubicadas la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": [
- {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un listado de todos los encargos de un profesor enviado por parametro
| professorId required | integer Identificador del usuario |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un encargo para un profesor
| professorId required | integer Identificador del usuario |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Retorna un listado de todos los encargos del sistema
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Actualiza los datos de un encargo
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Deshabilita un encargo
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}retorna el listado de tareas pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna el listado de actividades pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- { }
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna al profesor perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}retorna la materia perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}retorna la fuentes pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agrega fuentes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
| source_catalog_id | integer |
| title | string |
| url_file | string |
| start | string |
| last | string |
[- {
- "source_catalog_id": 5,
- "title": "Titulo de la fuente",
- "start": "10:25",
- "last": "15:00"
}
]{- "data": [
- {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna el catalogo de accion perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "action_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el formato de entrega perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "delivery_format_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna las fuentes del catálogo pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- {
- "source_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las acciones creadas
{- "data": [
- {
- "action_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la información de un registro de catálogo de acciones enviado por parametro
| catalogActionId required | integer Identificador del catalogo de acciones |
{- "data": {
- "action_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el listado de encargos pertenecientes a catalogo de accion enviado por parametro
| catalogActionId required | integer Identificador del catalogo de acciones |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas creadas
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Actualiza información de una tarea referentes a un encargo en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Retorna información de una tarea en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Retorna información del estudiante referente a una tarea en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna información de todas las notificacion referentes a una tarea en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna el encargo de una tarea enviada por parametro
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Retorna información de todas las notificaciones de tareas creadas
{- "data": [
- {
- "id": 1,
- "homework_id": 1,
- "parent_notice_id": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de una notificación de tarea en sistema
| homeworkNotificationId required | integer Identificador de la notificación de tarea |
{- "data": {
- "id": 1,
- "homework_id": 1,
- "parent_notice_id": 1
}
}Retorna información de todo el catálogo de fuentes en sistema
{- "data": [
- {
- "source_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un registro del catálogo de fuentes en sistema
| catalogSourceId required | integer Identificador del catalogo de fuentes |
{- "data": {
- "source_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el listado de encargos pertenecientes a un catálogo de fuente enviada por parametro
| catalogSourceId required | integer Identificador del catalogo de fuentes |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todo el catálogo de formato de entrega en sistema
{- "data": [
- {
- "delivery_format_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un registro del catálogo de formato de entrega en sistema
| catalogDeliveryFormatId required | integer Identificador del catalogo de formatos de entrega |
{- "data": {
- "delivery_format_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el listado de encargos pertenecientes a un catálogo de formato de entrega enviada por parametro
| catalogDeliveryFormatId required | integer Identificador del catalogo de formatos de entrega |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las fuentes creadas
{- "data": [
- {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de una fuente enviada por parametro
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
}Actualiza información de una fuente en sistema
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
}Deshabilita una fuente
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
}retorna el encargo perteneciente a una fuente enviada por parametro
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Crea multiples recursos de Encargo sobre una sola materia
| professorId required | integer Identificador del usuario |
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas referentes a un profesor
| professorId required | integer Identificador del usuario |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todos los encargos referentes a una materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas referente a una materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todos los encargos referentes a un alumno
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas referentes a un alumno
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de una tarea referente a una notificacaion
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Retorna información de todas las tareas referentes a un padre
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna los convenios que tiene un usuario
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna los pagos que tiene un usuario
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las escuelas que tengan ese catalogo de conceptos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las escuelas que tengan ese catalogo de descuentos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las escuelas que tengan ese catalogo de recargos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los conceptos
{- "data": [
- {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los conceptos
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un catalogo de conceptos
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un concepto del catalogo
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
| concept | string |
| active | boolean |
| value | number |
[- {
- "concept": "colegiatura",
- "active": 1,
- "value": 1550.5
}
]{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega nuevo catalogo
| schoolId required | integer Identificador de la escuela |
| concept | string |
| active | boolean |
| value | number |
[- {
- "concept": "colegiatura",
- "active": 1,
- "value": 1550.5
}
]{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los conceptos que contengan el id_catalogconcept específicado
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": [
- {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos las escuelas que contengan el id_catalogconcept específicado
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": [
- {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los conceptos
{- "data": [
- {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un concepto
| conceptId required | integer Identificador del concepto |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un concepto
| conceptId required | integer Identificador del concepto |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un concepto
| conceptId required | integer Identificador del concepto |
| description | string |
| limit_date | string |
[- {
- "description": "Pago de Mensualidad correspondiente al mes de junio",
- "limit_date": "2024-06-15"
}
]{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo concepto
| studentId required | integer Identificador del alumno |
| description | string |
| limit_date | string |
[- {
- "description": "Pago de Mensualidad",
- "limit_date": "2024-06-15"
}
]{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un catalogo de conceptos al que corresponda el concepto específica
| conceptId required | integer Identificador del concepto |
{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un convenio al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un pago al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un alumno al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los descuentos
{- "data": [
- {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un descuento del catalogo
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un catalogo de descuentos
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un descuento del catalogo
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Promedio",
- "value": 500,
- "value_modality": 2
}
]{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega nuevo catalogo de descuentos
| schoolId required | integer Identificador de la escuela |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Promedio",
- "value": 550,
- "value_modality": 1
}
]{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los descuentos del catalogo de descuentos segun el ID especificado
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": [
- {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela correspondiente al catalogo de descuentos segun el ID especificado
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los descuentos
{- "data": [
- {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un descuento
| discountId required | integer Identificador del descuento |
{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un descuento
| discountId required | integer Identificador del descuento |
{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un descuento
| discountId required | integer Identificador del descuento |
| description | string |
| amount | number |
[- {
- "description": "Descuento por promedio",
- "amount": 500
}
]{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo descuento
| conceptId required | integer Identificador del concepto |
| description | string |
| amount | number |
[- {
- "description": "Descuento por promedio (90.0)",
- "amount": 500
}
]{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un descuento al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el catalogo de descuentso que tiene un descuento segun el ID del descuento especificado
| discountId required | integer Identificador del descuento |
{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene un descuento segun el ID del descuento especificado
| discountId required | integer Identificador del descuento |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los recargos
{- "data": [
- {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un recargo del catalogo
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un catalogo de recargos
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un recargo del catalogo
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Pago Tardio",
- "value": 100,
- "value_modality": 1
}
]{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega nuevo catalogo de recargos
| schoolId required | integer Identificador de la escuela |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Promedio",
- "value": 550,
- "value_modality": 1
}
]{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los recargos del catalogo de recargos segun el ID especificado
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": [
- {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela correspondiente al catalogo de recargos segun el ID especificado
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los recargos
{- "data": [
- {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un recargo
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un recargo
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un recargo
| surchargeId required | integer Identificador del recargo |
| description | string |
| amount | number |
[- {
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100
}
]{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo recargo
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
| description | string |
| amount | number |
[- {
- "description": "Recargo por pago tardio",
- "amount": 100
}
]{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un recargo al que corresponda el concepto específicado
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el catalogo de recargos que tiene un recargo segun el ID del descuento especificado
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene un recargo segun el ID del recargo especificado
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los convenios
{- "data": [
- {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un Convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un convenio
| agreementId required | integer Identificador del convenio |
| term | integer |
| term_type | integer |
[- {
- "term": 5,
- "term_type": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene el ID del convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el usuario que tiene el ID del convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Agrega un nuevo convenio
| conceptId required | integer Identificador del concepto |
| term | integer |
| term_type | integer |
[- {
- "term": 5,
- "term_type": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo convenio
| conceptId required | integer Identificador del concepto |
| term | integer |
| term_type | integer |
[- {
- "term": 5,
- "term_type": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los pagos
{- "data": [
- {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un pago
| paymentId required | integer Identificador del pago |
{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un Pago
| paymentId required | integer Identificador del pago |
{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un Pago
| paymentId required | integer Identificador del pago |
| amount | number |
| payment_method | integer |
| canceled | boolean |
[- {
- "amount": 1200,
- "payment_method": 2,
- "canceled": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene un pago segun el ID del pago especificado
| paymentId required | integer Identificador del pago |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el usuario que tiene un pago segun el ID del pago especificado
| paymentId required | integer Identificador del pago |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Agrega un nuevo Pago
| conceptId required | integer Identificador del concepto |
| amount | number |
| payment_method | integer |
[- {
- "amount": 1200,
- "payment_method": 1
}
]{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo Pago
| conceptId required | integer Identificador del concepto |
| amount | number |
| payment_method | integer |
[- {
- "amount": 1200,
- "payment_method": 1
}
]{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los conceptos asignados de un alumno segun su student_id
| studentId required | integer Identificador del alumno |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la lista de configuraciones que pueden alterar el funcionamiento general de eficaz
{- "data": [
- {
- "configuration_id": 1,
- "key": "notifications-small-icon",
- "value": "@/normal-sm-icon",
- "description": "Límite de reportes",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la configuración especificada en la ruta
| configurationId required | integer Identificador de la configuracion |
{- "data": {
- "configuration_id": 1,
- "key": "notifications-small-icon",
- "value": "@/normal-sm-icon",
- "description": "Límite de reportes",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna un listado de todos los usuarios del sistema
{- "data": [
- {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna los datos de un usuario
| userId required | integer Identificador del usuario |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Actualiza los datos de un usuario
| userId required | integer Identificador del usuario |
| password | string <password> >= 6 Nueva contraseña |
| password_confirmation | string <password> >= 6 Repetir nueva contraseña |
| password_old | string <password> >= 6 Contraseña anterior |
| cellphone | string <= 11 Cambiar el usuario |
| group_id | string |
| remove_group_id | string |
| close_all_sessions | number Default: 1 Revoca todos los tokens |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Deshabilita un usuario
| userId required | integer Identificador del usuario |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Retorna un listado de noticias que el sistema a enviado al usuario identificado en ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un listado de notificaciones que el sistema a enviado al usuario identificado en ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un listado de licencias de trabajo donde el usuario identificado en la ruta puede operar
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un listado de validacions creadas por el usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna los convenios que tiene un usuario
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna los pagos que tiene un usuario
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un incidente
| latitude required | integer Latitud de la ubicacion |
| longitude required | integer Longitud de la ubicacion |
| catalog_incident_id | integer Identificador del catalogo del incidente |
| description | string Descripción del incidente |
{- "data": {
- "incident_id": 1,
- "user_id": 1,
- "url_video": null,
- "status": 1,
- "latitude": "37.421875199999995",
- "longitude": "-122.0851173",
- "catalog_incident_id": 1,
- "description": "Una persona externa quiere llevarse a varios niños",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Crea la Importación de un archivo enviado por un usuario
| userId required | integer Identificador del usuario |
| file | string <binary> |
| import_type | string |
| location | string |
{- "data": {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
}Retorna todas las importaciones creadas por un usuario
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de padres
{- "data": [
- {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear un padre que al inicio puede no ser un trabajador de una escuela
Datos necesarios para crear un usuario
| enrollment | string <= 50 characters Folio del usuario usando dentro de su centro de trabajo |
| name required | string <= 50 characters Nombre del usuario |
| last_name required | string <= 50 characters Apellido paterno |
| second_last_name | string <= 50 characters Apellido materno |
string <email> <= 50 characters Correo electrónico | |
| cellphone required | string <= 10 characters Número de celular |
| colony required | string <= 50 characters Colonia |
| inside_number | string <= 20 characters Número interior |
| outside_number required | string <= 20 characters Número exterior |
| street required | string <= 50 characters Calle |
| zipcode required | string <= 5 characters Código postal |
| city_id | integer Identificador de la ciudad de domicilio |
| birth_city_id | integer Identificador de la ciudad de nacimiento |
| level_education | integer Nivel máximo de estudio |
| curp | string <= 18 characters CURP |
| rfc | string <= 13 characters RFC |
| date_birth | string <date> Fecha de nacimiento |
| gender | integer Genero |
| is_trained | boolean Define si el usuario ya ha sido capacitado |
| is_stranger | boolean Define si el usuario es extranjero |
| is_foreign | boolean Define si el usuario es foraneo |
| is_immigrant | boolean Define si el usuario es inmigrante |
| is_indigenous | boolean Define si el usuario es indígena |
| user_id | integer Identificador del usuario |
| credential_id | integer Identificador de la credencial de acceso |
| school_id | integer Deprecated Identificador de la escuela donde se trabaja |
| has_smartphone | boolean Define si el usuario tiene un teléfono celular |
| send_sms | boolean Define si el usuario es capas de recibir mensajes SMS |
| country_code | string Código telefónico del país |
| group_id | string Deprecated Define los roles soportados por el usuario |
| created_by | integer Identificador del usuario, quien fue el creador del nuevo usuario |
| updated_at | string <date-time> Fecha cuando fue creado el usuario |
| created_at | string <date-time> Fecha cuando fue actualizado el usuario |
| url_photo_profile | string URL de la imagen de perfil |
| status | number Estado del usuario |
| push_id | string Identificador del Servicio de OneSignal |
| push_token | string Token del Servicio de OneSignal |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Retorna el padres especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Actualiza el padre identificado en la ruta, aqui no es posible cambiar de usuario ni de telefono
| userId required | integer Identificador del usuario |
| name | string <= 100 characters |
| last_name | string <= 100 characters |
| second_last_name | string <= 100 characters |
string <email> <= 100 characters | |
| colony | string <= 100 characters |
| inside_number | string <= 25 characters |
| outside_number | string <= 25 characters |
| street | string <= 50 characters |
| zipcode | string <= 15 characters |
| status | string <= 15 characters Enum: "0" "1" |
| push_id | string <= 15 characters |
| push_token | string <= 15 characters |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Da de baja el padre que esta identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Retorna la lista de notificaciones del padre identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de noticias del padre identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de parentescos del padre identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de alumnos del padre identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna información de todas las tareas referentes a un padre
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de directores
{- "data": [
- {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el director especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Actualiza el director especificado en la ruta
| userId required | integer Identificador del usuario |
| name | string <= 100 characters |
| last_name | string <= 100 characters |
| second_last_name | string <= 100 characters |
string <email> <= 100 characters | |
| colony | string <= 100 characters |
| inside_number | string <= 25 characters |
| outside_number | string <= 25 characters |
| street | string <= 50 characters |
| zipcode | string <= 15 characters |
| status | string <= 15 characters Enum: "0" "1" |
| push_id | string <= 15 characters |
| push_token | string <= 15 characters |
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Da de baja el director especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Retorna la escuela de el director especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de todos los profesores del sistema
{- "data": [
- {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el profesor que esta especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Actualiza el profesor que esta especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Da de baja el profesor que esta especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Retorna la escuela a la que pertenece el profesor especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la lista de reportes creados pertenece el profesor especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de noticias enviadas al profesor especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de notificaciones enviadas al profesor especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de grupos en los que el profesor especificado en la ruta importa clases
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la lista de materias que importe el profesor especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una materia al profesor especificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna los incidentes de un profesor
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "incident_id": 1,
- "user_id": 1,
- "url_video": null,
- "status": 1,
- "latitude": "37.421875199999995",
- "longitude": "-122.0851173",
- "catalog_incident_id": 1,
- "description": "Una persona externa quiere llevarse a varios niños",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un listado de todos los encargos de un profesor enviado por parametro
| professorId required | integer Identificador del usuario |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un encargo para un profesor
| professorId required | integer Identificador del usuario |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Crea multiples recursos de Encargo sobre una sola materia
| professorId required | integer Identificador del usuario |
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas referentes a un profesor
| professorId required | integer Identificador del usuario |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los asesores del sistema
{- "data": [
- {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un asesor en especifico
| userId required | integer Identificador del usuario |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Actualiza todas las propiedades de un asesor
| userId required | integer Identificador del usuario |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Eliminar un asesor
| userId required | integer Identificador del usuario |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra las notificacaiones
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los expedientes asignados al asesor
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los avisos
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela a la que pertenece el asesor
| userId required | integer Identificador del usuario |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los grupos asesorados
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los voseros del sistema
{- "data": [
- {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un voseros en especifico
| userId required | integer Identificador del usuario |
{- "data": {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Actualiza todas las propiedades de un voseros
| userId required | integer Identificador del usuario |
{- "data": {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Eliminar un voseros
| userId required | integer Identificador del usuario |
{- "data": {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra las noticias creadas por el voseros
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las escuela a la que pertenece el usuario
| userId required | integer Identificador del usuario |
{- "data": [
- {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los administradores del sistema
{- "data": [
- {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear un administrador que aun no cuenta con una escuela para administrar
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra un administrador en especifico
| userId required | integer Identificador del usuario |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Actualiza todas las propiedades de un administrador
| userId required | integer Identificador del usuario |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Eliminar un administrador
| userId required | integer Identificador del usuario |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra la escuela que administra
| userId required | integer Identificador del usuario |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Crea una nueva escuela
| userId required | integer Identificador del usuario |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra la ciudad donde nacio del usuario identificado en la ruta
| userId required | integer Identificador del usuario |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los escuelas del sistema
{- "data": [
- {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela con el identificador enviado por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza todas las propiedades de una escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar una escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los profesores de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo profesor que podra dar clases en algún grupo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Retorna todos los asesores de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo asesor que podra gestionar los reportes de un grupo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra los voseros de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo vosero que podra enviar avisos a todos los usuarios de eficaz
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra los voseros de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "spokesman_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un administradores de la escuelas enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo administrador que podra gestionar las operaciones de una escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "administrator_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra los grupos de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear un grupo
| schoolId required | integer Identificador de la escuela |
| grade required | integer Grado del grupo |
| group required | string Nombre del grupo |
| turn | integer Turno del grupo |
| level | integer Nivel del grupo |
| special | integer Determina si es especialel grupo |
| annexed | boolean Determina si sera anexado |
| annexed_name | string Nombre mostrado en la boleta |
| combined | integer Determina la vista del grupo; Materia, multi-materia |
{- "grade": 1,
- "group": "A",
- "turn": 1,
- "level": 3,
- "special": 1,
- "annexed": false,
- "annexed_name": "Tecnologia II",
- "combined": 3
}{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Registra y asigna un nuevo alumno a un grupo
| schoolId required | integer Identificador de la escuela |
| groupId required | integer Identificador del grupo |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra las configuraciones de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "configuration_id": "1",
- "school_id": "1",
- "key": "files-report-limite-active",
- "value": "3",
- "description": "Lmite de reportes para mandar mensajes",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un catalogo de materias de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "catalog_subject_id": 0,
- "school_id": 0,
- "title": "string",
- "folio": "string",
- "level": 0,
- "groups": 0,
- "is_discarted": true,
- "professors": 0,
- "education_plan_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear un catalogo de materias
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "catalog_subject_id": 0,
- "school_id": 0,
- "title": "string",
- "folio": "string",
- "level": 0,
- "groups": 0,
- "is_discarted": true,
- "professors": 0,
- "education_plan_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra alumnos en especifico
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo alumno listo para ser asignado a un grupo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los avisos de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las materias de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los reportes de alumno de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las relaciones entre un usuario y un alumno de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los parciales de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear parciales
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el catalogo de reportes de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear catalogo de reporte
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los padres de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo padre que podra ser gestionado por la escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra las actividades de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- { }
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los directores de la escuela envida por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un nuevo director que podra observar las estadisticas de la escuela
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "user_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra cortes de ciclos de la escuela enviada por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "cycle_id": 0,
- "school_id": 0,
- "cycle": "string",
- "level": 0,
- "segment_cut": 0,
- "snaphot": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea corte un corte de ciclos
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "cycle_id": 0,
- "school_id": 0,
- "cycle": "string",
- "level": 0,
- "segment_cut": 0,
- "snaphot": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el listado de licecias de usuario pueden operar en la escuela identificado en la ruta
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una licencia de trabajo
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el listado de rastreos de alumnos de la escuela enviada en la ruta
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad donde esta ubicada la escuela identificado en la ruta
| schoolId required | integer Identificador de la escuela |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna uns lista de documentos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las escuelas que tengan ese catalogo de conceptos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las escuelas que tengan ese catalogo de descuentos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las escuelas que tengan ese catalogo de recargos
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las valdiaciones de parciales de la escuela enviad por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna las importaciones de la escuela enviad por parametro
| schoolId required | integer Identificador de la escuela |
{- "data": [
- {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra y asigna un nuevo alumno a un grupo
| schoolId required | integer Identificador de la escuela |
| groupId required | integer Identificador del grupo |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Asigna solo un grupo principal o varios grupos especiales, si el alumno ya cuenta con un grupo principal y se vuelve a ejecutar esta peticion resultara en un error
| studentId required | integer Identificador del alumno |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Cambia grupos de un alumno, ya sea principal o especial, si el alumno ya cuenta con el grupo enviado resultara en un error
| studentId required | integer Identificador del alumno |
| groupId required | integer Identificador del grupo |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los ajustes de todas las escuelas
{- "data": [
- {
- "configuration_id": "1",
- "school_id": "1",
- "key": "files-report-limite-active",
- "value": "3",
- "description": "Lmite de reportes para mandar mensajes",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos del ajuste enviado por parametro
| settingId required | integer Identificador de la configuracion |
{- "data": {
- "configuration_id": "1",
- "school_id": "1",
- "key": "files-report-limite-active",
- "value": "3",
- "description": "Lmite de reportes para mandar mensajes",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores del ajuste enviado por parametro
| settingId required | integer Identificador de la configuracion |
{- "data": {
- "configuration_id": "1",
- "school_id": "1",
- "key": "files-report-limite-active",
- "value": "3",
- "description": "Lmite de reportes para mandar mensajes",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la escuela del ajuste enviado por parametro
| settingId required | integer Identificador de la configuracion |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los conceptos
{- "data": [
- {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los conceptos
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un catalogo de conceptos
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un concepto del catalogo
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
| concept | string |
| active | boolean |
| value | number |
[- {
- "concept": "colegiatura",
- "active": 1,
- "value": 1550.5
}
]{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega nuevo catalogo
| schoolId required | integer Identificador de la escuela |
| concept | string |
| active | boolean |
| value | number |
[- {
- "concept": "colegiatura",
- "active": 1,
- "value": 1550.5
}
]{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los conceptos que contengan el id_catalogconcept específicado
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": [
- {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos las escuelas que contengan el id_catalogconcept específicado
| CatalogConceptId required | integer Identificador del catalogo de conceptos |
{- "data": [
- {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los conceptos
{- "data": [
- {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un concepto
| conceptId required | integer Identificador del concepto |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un concepto
| conceptId required | integer Identificador del concepto |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un concepto
| conceptId required | integer Identificador del concepto |
| description | string |
| limit_date | string |
[- {
- "description": "Pago de Mensualidad correspondiente al mes de junio",
- "limit_date": "2024-06-15"
}
]{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo concepto
| studentId required | integer Identificador del alumno |
| description | string |
| limit_date | string |
[- {
- "description": "Pago de Mensualidad",
- "limit_date": "2024-06-15"
}
]{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un catalogo de conceptos al que corresponda el concepto específica
| conceptId required | integer Identificador del concepto |
{- "data": {
- "concept_catalog_id": 25,
- "concept": "Incripción",
- "school_id": 256,
- "active": 1,
- "value": 1450,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un convenio al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un pago al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un alumno al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un descuento al que corresponda el concepto específicado
| conceptId required | integer Identificador del concepto |
{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un recargo al que corresponda el concepto específicado
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los descuentos
{- "data": [
- {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un descuento del catalogo
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un catalogo de descuentos
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un descuento del catalogo
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Promedio",
- "value": 500,
- "value_modality": 2
}
]{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega nuevo catalogo de descuentos
| schoolId required | integer Identificador de la escuela |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Promedio",
- "value": 550,
- "value_modality": 1
}
]{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los descuentos del catalogo de descuentos segun el ID especificado
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": [
- {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela correspondiente al catalogo de descuentos segun el ID especificado
| CatalogDiscountId required | integer Identificador del catalogo de descuentos |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los descuentos
{- "data": [
- {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un descuento
| discountId required | integer Identificador del descuento |
{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un descuento
| discountId required | integer Identificador del descuento |
{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un descuento
| discountId required | integer Identificador del descuento |
| description | string |
| amount | number |
[- {
- "description": "Descuento por promedio",
- "amount": 500
}
]{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo descuento
| conceptId required | integer Identificador del concepto |
| description | string |
| amount | number |
[- {
- "description": "Descuento por promedio (90.0)",
- "amount": 500
}
]{- "data": {
- "discount_id": 15,
- "discount_catalog_id": 5,
- "description": "Descuento por promedio",
- "concept_id": 8,
- "amount": 350,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el catalogo de descuentso que tiene un descuento segun el ID del descuento especificado
| discountId required | integer Identificador del descuento |
{- "data": {
- "discount_catalog_id": 4,
- "title": "Promedio",
- "value": 500.5,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene un descuento segun el ID del descuento especificado
| discountId required | integer Identificador del descuento |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los recargos
{- "data": [
- {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un recargo del catalogo
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un catalogo de recargos
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un recargo del catalogo
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Pago Tardio",
- "value": 100,
- "value_modality": 1
}
]{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega nuevo catalogo de recargos
| schoolId required | integer Identificador de la escuela |
| title | string |
| value | number |
| value_modality | integer |
[- {
- "title": "Promedio",
- "value": 550,
- "value_modality": 1
}
]{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los recargos del catalogo de recargos segun el ID especificado
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": [
- {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela correspondiente al catalogo de recargos segun el ID especificado
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los recargos
{- "data": [
- {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un recargo
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un recargo
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un recargo
| surchargeId required | integer Identificador del recargo |
| description | string |
| amount | number |
[- {
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100
}
]{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo recargo
| CatalogSurchargeId required | integer Identificador del catalogo de recargos |
| description | string |
| amount | number |
[- {
- "description": "Recargo por pago tardio",
- "amount": 100
}
]{- "data": {
- "surcharge_id": 7,
- "surcharge_catalog_id": 4,
- "description": "Recargo por exceder fecha limite de pago",
- "amount": 100,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el catalogo de recargos que tiene un recargo segun el ID del descuento especificado
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "surcharge_catalog_id": 4,
- "title": "Pago tardio",
- "value": 100,
- "value_modality": 2,
- "school_id": 5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene un recargo segun el ID del recargo especificado
| surchargeId required | integer Identificador del recargo |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los convenios
{- "data": [
- {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un Convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un convenio
| agreementId required | integer Identificador del convenio |
| term | integer |
| term_type | integer |
[- {
- "term": 5,
- "term_type": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene el ID del convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el usuario que tiene el ID del convenio
| agreementId required | integer Identificador del convenio |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Agrega un nuevo convenio
| conceptId required | integer Identificador del concepto |
| term | integer |
| term_type | integer |
[- {
- "term": 5,
- "term_type": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo convenio
| conceptId required | integer Identificador del concepto |
| term | integer |
| term_type | integer |
[- {
- "term": 5,
- "term_type": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los pagos
{- "data": [
- {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un pago
| paymentId required | integer Identificador del pago |
{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un Pago
| paymentId required | integer Identificador del pago |
{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un Pago
| paymentId required | integer Identificador del pago |
| amount | number |
| payment_method | integer |
| canceled | boolean |
[- {
- "amount": 1200,
- "payment_method": 2,
- "canceled": 1
}
]{- "data": {
- "agreement_id": 58,
- "term": 2,
- "term_type": 3,
- "accumulated_amount": 380,
- "user_id": 18,
- "next_payment_date": "2024-07-15",
- "status": 1,
- "concept_id": 25,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el concepto que tiene un pago segun el ID del pago especificado
| paymentId required | integer Identificador del pago |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el usuario que tiene un pago segun el ID del pago especificado
| paymentId required | integer Identificador del pago |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Agrega un nuevo Pago
| conceptId required | integer Identificador del concepto |
| amount | number |
| payment_method | integer |
[- {
- "amount": 1200,
- "payment_method": 1
}
]{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agrega un nuevo Pago
| conceptId required | integer Identificador del concepto |
| amount | number |
| payment_method | integer |
[- {
- "amount": 1200,
- "payment_method": 1
}
]{- "data": {
- "payment_id": 0,
- "amount": 0,
- "payment_method": 0,
- "date": "string",
- "chargeback_status": 0,
- "concept_id": 0,
- "user_id": 0,
- "cancelled": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todos los alumnos
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos el alumno enviados por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Da de baja un alumno
| studentId required | integer Identificador del alumno |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los conceptos asignados de un alumno segun su student_id
| studentId required | integer Identificador del alumno |
{- "data": {
- "concept_id": 25,
- "concept_catalog_id": 5,
- "subtotal": 1450,
- "description": "Pago de mensualidad correspondiente al mes de junio",
- "limit_date": "string",
- "net_total": 1300,
- "discount_total": 100,
- "remaining": 500,
- "status": 2,
- "surcharge_total": 50,
- "student_id": 11,
- "in_agreement": 1,
- "in_surcharge": 1,
- "in_discount": 1,
- "last_payment_date": "2024-05-15",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Crea una relación entre padre y alumno, sí el alumno tiene notificaciones eliminadas estas serán agregadas al nuevo padre
| studentId required | integer Identificador del alumno |
| userId required | integer Identificador del usuario |
{- "data": {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
}Muestra los padres del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Elimina la relacion entre un padre y un alumno, pero esto no elimina las notificaciones, que seran agregadas a la siguiente relacion creada
| studentId required | integer Identificador del alumno |
{- "data": {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
}Muestra las relaciones del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los expedientes del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear expedientes a un alumno
| studentId required | integer Identificador del alumno |
| fileId required | integer Identificador del expediente |
{- "data": {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los profesores que dan clase al alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los reportes del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela a la que pertenece el alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el grupos principal del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Asigna solo un grupo principal o varios grupos especiales, si el alumno ya cuenta con un grupo principal y se vuelve a ejecutar esta peticion resultara en un error
| studentId required | integer Identificador del alumno |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Cambia grupos de un alumno, ya sea principal o especial, si el alumno ya cuenta con el grupo enviado resultara en un error
| studentId required | integer Identificador del alumno |
| groupId required | integer Identificador del grupo |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Quita el grupo al alumno enviado por parametro
| studentId required | integer Identificador del alumno |
| groupId required | integer Identificador del grupo |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los grupos especiales del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las calificaciones del alumno envido por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las asistencias del alumno enviadas por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las materias del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agregar una materia al alumno enviado por parametro, tener cuidado de que la materia pertenesca a alguno de los grupos que pertenecen al alumno
| studentId required | integer Identificador del alumno |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Quitar materias del alumno enviado por parametro y deshabilita sus asistencias
| studentId required | integer Identificador del alumno |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Nombrar asistencia a un solo alumno
| studentId required | integer Identificador del alumno |
| subjectId required | integer Identificador de la materia |
{- "data": {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Captura una calificación a un solo alumno
| studentId required | integer Identificador del alumno |
| subjectId required | integer Identificador de la materia |
{- "data": {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra las notificaciones del alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agregar un reporte al alumno enviado por parametro
| studentId required | integer Identificador del alumno |
| userId required | integer Identificador del usuario |
{- "data": {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de idiomas habladas por el alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agregar un idioma al alumno envido por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina la relacion de un idioma con un alumno
| studentId required | integer Identificador del alumno |
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de caracteristica que describen al alumno enviado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea una relacion de un alumno con una caracteristica
| studentId required | integer Identificador del alumno |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina la relacion de una caracteristica con un alumno
| studentId required | integer Identificador del alumno |
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de los documentos adjuntos al alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un documento al alumno envido por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una lista de las redes sociales pertenecientes al alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agregar una red social al alumno enviado por parametro
| studentId required | integer Identificador del alumno |
{- "data": {
- "socialmedia_id": 0,
- "student_id": 0,
- "user_id": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el rastreo a traves varias escuelas del alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la ciudad de nacimiento del alumno identificado en la ruta
| studentId required | integer Identificador del alumno |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna información de todos los encargos referentes a un alumno
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas referentes a un alumno
| studentId required | integer Identificador del alumno |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todas las relaciones
{- "data": [
- {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos de la relacion enviada por parametro
| relationshipId required | integer Identificador de la relacion |
{- "data": {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
}Modificar los datos de la relacion enviada por parametro
| relationshipId required | integer Identificador de la relacion |
{- "data": {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
}Elimina relacion de padres y un alumno
| relationshipId required | integer Identificador de la relacion |
{- "data": {
- "relationship_id": 327,
- "parent_id": 405,
- "student_id": 35,
- "relationship": 1,
- "created_at": "2021-07-24 02:12:07",
- "updated_at": "2021-07-24 02:12:07"
}
}Muestra el alumno de la relacion enviada por parametro
| relationshipId required | integer Identificador de la relacion |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el padre de la relacion enviada por parametro
| relationshipId required | integer Identificador de la relacion |
{- "data": {
- "parent_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra todo el catalogo de reportes
{- "data": [
- {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear un catalogo de reporte
{- "data": {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los datos de catalogo de report enviado por parametro
| reportcatalogId required | integer Identificador de la relacion |
{- "data": {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de catalogo enviado por parametro
| reportcatalogId required | integer Identificador de la relacion |
{- "data": {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un catalogo de reporte
| reportcatalogId required | integer Identificador de la relacion |
{- "data": {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los reportes del catalogo de reportes enviado por parametro
| reportcatalogId required | integer Identificador de la relacion |
{- "data": [
- {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra la escuela del reporte envido por parametro
| reportcatalogId required | integer Identificador de la relacion |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas los expedientes
{- "data": [
- {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos del expediente envido por parametro
| fileId required | integer Identificador del expediente |
{- "data": {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un expediente
| fileId required | integer Identificador del expediente |
{- "data": {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un expediente
| fileId required | integer Identificador del expediente |
{- "data": {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra reportes que le pertenece el expediente
| fileId required | integer Identificador del expediente |
{- "data": [
- {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra a que alumno le pertenece el expediente
| fileId required | integer Identificador del expediente |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra a que asesor le pertenece el expediente
| fileId required | integer Identificador del expediente |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra notas que pertenecen al expediente
| fileId required | integer Identificador del expediente |
{- "data": [
- {
- "note_id": 0,
- "file_id": 0,
- "comentary": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crear una nota
| fileId required | integer Identificador del expediente |
{- "data": {
- "note_id": 0,
- "file_id": 0,
- "comentary": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Agergar un reporte a un expediente
| fileId required | integer Identificador del expediente |
| userId required | integer Identificador del usuario |
{- "data": {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas los reportes
{- "data": [
- {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos del reporte enviado por parametro
| reportId required | integer Identificador de la materia |
{- "data": {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un reporte
| reportId required | integer Identificador de la materia |
{- "data": {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un reporte
| reportId required | integer Identificador de la materia |
{- "data": {
- "report_id": 0,
- "file_id": 0,
- "profesor_id": 0,
- "catalog_report_id": 0,
- "description": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los datos del expediente pertenece al reprote enviado por parametro
| reportId required | integer Identificador de la materia |
{- "data": {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra cual profesor creo el reporte
| reportId required | integer Identificador de la materia |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Muestra a que catalogo de reporte pertenecee
| reportId required | integer Identificador de la materia |
{- "data": {
- "catalog_report_id": 1,
- "school_id": 1,
- "title": "El alumno no asistido a clases",
- "status": {
- "1": {
- "summary": "Activo",
- "description": "Estado cuando el reporte puede ser usado",
- "value": 1
}
}, - "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas las notificaciones
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos de la notificacion enviada por parametro
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de una notificacion
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra a que aviso pertenecee
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra que usuario pertenece la notificacion
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Muestra a que alumno pertenece
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna información de una tarea referente a una notificacaion
| notificationId required | integer Identificador de la notificacion |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Muestra todas los avisos
{- "data": [
- {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos del aviso enviado por parametro
| noticeId required | integer Identificador del aviso |
{- "data": {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un aviso
| noticeId required | integer Identificador del aviso |
{- "data": {
- "notice_id": 0,
- "user_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra un listado de notificaciones
| noticeId required | integer Identificador del aviso |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra el usuario que emitio en aviso enviado por parametro
| noticeId required | integer Identificador del aviso |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Muestra la notificación de tarea que pertenece al aviso
| noticeId required | integer Identificador del aviso |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Muestra todos el catalogo de materias
{- "data": [
- {
- "catalog_subject_id": 0,
- "school_id": 0,
- "title": "string",
- "folio": "string",
- "level": 0,
- "groups": 0,
- "is_discarted": true,
- "professors": 0,
- "education_plan_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos del catalogo de materias enviado por parametro
| subjectcatalogId required | integer Identificador del aviso |
{- "data": {
- "catalog_subject_id": 0,
- "school_id": 0,
- "title": "string",
- "folio": "string",
- "level": 0,
- "groups": 0,
- "is_discarted": true,
- "professors": 0,
- "education_plan_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de un catalogo
| subjectcatalogId required | integer Identificador del aviso |
{- "data": {
- "catalog_subject_id": 0,
- "school_id": 0,
- "title": "string",
- "folio": "string",
- "level": 0,
- "groups": 0,
- "is_discarted": true,
- "professors": 0,
- "education_plan_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la escuela a la que pertenece el catalogo
| subjectcatalogId required | integer Identificador del aviso |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra las materias del catalogo de materias enviado por parametro
| subjectcatalogId required | integer Identificador del aviso |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todas las materias
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea multiples materias para un grupo especifico
| group_id | integer <integer> |
| subjects | Array of arrays |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra una materia
| subjectId required | integer Identificador de la materia |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de una materia
| subjectId required | integer Identificador de la materia |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una materia
| subjectId required | integer Identificador de la materia |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el catalogo de la materia
| subjectId required | integer Identificador de la materia |
{- "data": {
- "catalog_subject_id": 0,
- "school_id": 0,
- "title": "string",
- "folio": "string",
- "level": 0,
- "groups": 0,
- "is_discarted": true,
- "professors": 0,
- "education_plan_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el profesor que imparte la materia
| subjectId required | integer Identificador de la materia |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}Muestra las asistencias de la materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las calificacaiones de la materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los alumnos que acuden a esa materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra el grupo en el que se da la materia
| subjectId required | integer Identificador de la materia |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra las materias que se imparten en ese grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Elimina multiples materias que se imparten en un grupo especificado por parametro
| groupId required | integer Identificador del grupo |
| subjects | Array of arrays |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todos los encargos referentes a una materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas referente a una materia
| subjectId required | integer Identificador de la materia |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todas los grupos
{- "data": [
- {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra los datos del grupo enviado por parametro
| groupId required | integer Identificador del grupo |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de una grupo
| groupId required | integer Identificador del grupo |
{- "data": {
- "group_id": 0,
- "school_id": 0,
- "assessor_id": 0,
- "grade": 0,
- "group": 0,
- "turn": 0,
- "level": 0,
- "students": 0,
- "subjects": 0,
- "special": 0,
- "annexed": true,
- "annexed_name": "Tecnologia 1",
- "combined": 1,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "total_reports": 0,
- "total_students_reported": 2,
- "average_ungraded_students": 10.5,
- "subjects_without_professors": 2,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la escuela a la que pertenece el grupo
| groupId required | integer Identificador del grupo |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los estudiantes del grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las materias que se imparten en ese grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra al asesor del grupo
| groupId required | integer Identificador del grupo |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Asigana o cambia el asesor de un grupo
| groupId required | integer Identificador del grupo |
{- "data": {
- "assessor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true
}
}Muestra los expedientes de alumnos que pertenescan a ese grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las asistencias de alumnos que pertenescan a ese grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra las calificacaiones de alumnos que pertenescan a ese grupo
| groupId required | integer Identificador del grupo |
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todas las asistencias
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un bloque de asistencias
{- "data": [
- {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Modificar los valores de una asistencia
Array of objects |
{- "update": [
- {
- "assist_id": 65361,
- "is_justified": true,
- "reason_justification": "Le dio COVID-32"
}
]
}{- "data": {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra los datos de una asistencia
| assistId required | integer Identificador de la asistencia |
{- "data": {
- "assist_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial_id": 0,
- "assistance": true,
- "justification_reason": "string",
- "date": "string",
- "status": 0,
- "is_justified": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el alumno de la asistencia
| groupId required | integer Identificador del grupo |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la materia de la asistencia
| groupId required | integer Identificador del grupo |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el parcial en donde se realizo la falta
| groupId required | integer Identificador del grupo |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas las calificaciones
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Registra un bloque de asistencias
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra una calificación
| groupId required | integer Identificador del grupo |
{- "data": {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de una asistencia
| groupId required | integer Identificador del grupo |
{- "data": {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el alumno de la calificación
| calificationId required | integer Identificador de la calificación |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la materia de la calificación
| groupId required | integer Identificador del grupo |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el parcial en donde se realizo la calificación
| groupId required | integer Identificador del grupo |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas las notas
{- "data": [
- {
- "note_id": 0,
- "file_id": 0,
- "comentary": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra una nota
| noteId required | integer Identificador de la nota |
{- "data": {
- "note_id": 0,
- "file_id": 0,
- "comentary": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modificar los valores de una nota
| noteId required | integer Identificador de la nota |
{- "data": {
- "note_id": 0,
- "file_id": 0,
- "comentary": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una nota
| noteId required | integer Identificador de la nota |
{- "data": {
- "note_id": 0,
- "file_id": 0,
- "comentary": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra el expediente al que pertenece la nota
| noteId required | integer Identificador de la nota |
{- "data": {
- "file_id": 1,
- "assessor_id": 2,
- "student_id": 3,
- "folio": "string",
- "status": 0,
- "status_viewed": 0,
- "total_reports": 0,
- "total_notes": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra todas los cortes de ciclos
{- "data": [
- {
- "cycle_id": 0,
- "school_id": 0,
- "cycle": "string",
- "level": 0,
- "segment_cut": 0,
- "snaphot": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra un cortes de ciclo
| cycleId required | integer Identificador del ciclo |
{- "data": {
- "cycle_id": 0,
- "school_id": 0,
- "cycle": "string",
- "level": 0,
- "segment_cut": 0,
- "snaphot": "string",
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Muestra la escuela que creo el ciclo
| cycleId required | integer Identificador del ciclo |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de lenjuages e idiomas
{- "data": [
- {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Permite crear un nuevo idoma
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la informaicon del lenguaje enviado por parametro
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Modifica los valores de un lenguaje
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar el lenjuage enviado por parametro
| languageId required | integer Identificador del lenguaje |
{- "data": {
- "language_id": 0,
- "code": "string",
- "title": "string",
- "type": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de alumnos que hablan el idioma enviado por parametro
| languageId required | integer Identificador del lenguaje |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de validaciones de calificaciones
{- "data": [
- {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informaicon de la validación enviado por parametro
| validationId required | integer Identificador de la validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Permite actualizar los datos de una validación
| validationId required | integer Identificador de la validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una validación
| validationId required | integer Identificador de la validación |
{- "data": {
- "validation_level": 0,
- "user_id": 0,
- "validation_id": 0,
- "partial_id": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el parcial asociado a la validación enviada por parametro
| validationId required | integer Identificador de la validación |
{- "data": {
- "partial_id": 0,
- "school_id": 0,
- "partial": 1,
- "level": 1,
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "limit_date": "2019-08-24T14:15:22Z",
- "is_regularized": 0,
- "is_final": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el usuario que creo la validación enviada por parametro
| validationId required | integer Identificador de la validación |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Retorna un listado de calificaciones validadas por identificador enviada por parametro
| validationId required | integer Identificador de la validación |
{- "data": [
- {
- "calification_id": 0,
- "student_id": 0,
- "subject_id": 0,
- "partial": 0,
- "partial_id": 0,
- "is_final": true,
- "calification": 0,
- "status": 0,
- "description": "string",
- "in_regularization": true,
- "in_recovery": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de caracteristicas de alumnos
{- "data": [
- {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Crea un caracteristica
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la informaicon de la caracteristica enviado por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de la caracteristica enviada por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina la caracteristica enviada por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": {
- "characteristic_id": 0,
- "type": 0,
- "category": 0,
- "title": "string",
- "abbreviation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de alumnos con la caracteristica enviado por parametro
| characteristicId required | integer Identificador de una caracteristica |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de documentos del alumnos
{- "data": [
- {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del documento enviado por parametro
| documentId required | integer Identificador de un documento |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualizar los datos de un documento
| documentId required | integer Identificador de un documento |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualizar un documento
| documentId required | integer Identificador de un documento |
{- "data": {
- "document_id": 0,
- "student_id": 0,
- "type": 0,
- "url": "string",
- "folio": "string",
- "school_level": 0,
- "is_valid": true,
- "observation": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el alumno asociado al documento enviado por parametro
| documentId required | integer Identificador de un documento |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de licencias de trabajo
{- "data": [
- {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de la licencia enviada por parametro
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de una licencia
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina una licencia
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "license_id": 0,
- "user_id": 0,
- "school_id": 0,
- "profile": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la escuela asociada a la licencia enviado por parametro
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el usuario asociado a la licencia enviado por parametro
| licenceId required | integer Identificador de la licencia |
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Retorna una lista de rastros que los alumnos van dejando
{- "data": [
- {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del rastro enviado por parametro
| traceId required | integer Identificador de rastro |
{- "data": {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de un rastreo
| traceId required | integer Identificador de rastro |
{- "data": {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un rastreo
| traceId required | integer Identificador de rastro |
{- "data": {
- "trace_id": 0,
- "student_id": 0,
- "school_id": 0,
- "grade": 0,
- "group": "string",
- "turn": 0,
- "level": 0,
- "type": 0,
- "category": 0,
- "description": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el alumno asociado al rastreo enviado por parametro
| traceId required | integer Identificador de rastro |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la escuela asociada al rastreo enviado por parametro
| traceId required | integer Identificador de rastro |
{- "data": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de estados
{- "data": [
- {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del estado enviado por parametro
| stateId required | integer Identificador del estado |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de un estado
| stateId required | integer Identificador del estado |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Elimina un estado
| stateId required | integer Identificador del estado |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de paises
{- "data": [
- {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del pais enviado por parametro
| countryId required | integer Identificador del pais |
{- "data": {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualizar los datos de un pais
| countryId required | integer Identificador del pais |
{- "data": {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualziar los datos de un pais
| countryId required | integer Identificador del pais |
{- "data": {
- "country_id": 0,
- "title": "string",
- "nationality": "string",
- "code": 0,
- "region": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna una lista de estados que pertenecen al pais enviado por parametro
| countryId required | integer Identificador del pais |
{- "data": [
- {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de municipios
{- "data": [
- {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del municipio enviado por parametro
| municipalityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos del municipio
| municipalityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar un municipio
| municipalityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el estado al que pertenece el minicipio enviado por parametro
| municipalityId required | integer Identificador del pais |
{- "data": {
- "state_id": 0,
- "country_id": 0,
- "number": "string",
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna la lista de ciudades que pertenecen al minicipio enviado por parametro
| municipalityId required | integer Identificador del pais |
{- "data": [
- {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna una lista de ciudades
{- "data": [
- {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de la ciudad enviado por parametro
| cityId required | integer Identificador del pais |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de la clidad
| cityId required | integer Identificador del pais |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Eliminar una ciudad
| cityId required | integer Identificador del pais |
{- "data": {
- "city_id": 0,
- "municipality_id": 0,
- "title": "string",
- "code": "string",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el municipio al que pertenecen la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": {
- "municipality_id": 0,
- "state_id": 0,
- "number": "string",
- "title": "string",
- "code": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna el listado de alumnos que viven la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": [
- {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el listado de usuarios que viven la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": [
- {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna el listado de escuelas que estan ubicadas la ciudad enviada por parametro
| cityId required | integer Identificador del pais |
{- "data": [
- {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}{- "data": [
- {
- "incident_id": 1,
- "user_id": 1,
- "url_video": null,
- "status": 1,
- "latitude": "37.421875199999995",
- "longitude": "-122.0851173",
- "catalog_incident_id": 1,
- "description": "Una persona externa quiere llevarse a varios niños",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los incidentes
| incidents required | integer Identificador del incidente |
{- "data": {
- "incident_id": 1,
- "user_id": 1,
- "url_video": null,
- "status": 1,
- "latitude": "37.421875199999995",
- "longitude": "-122.0851173",
- "catalog_incident_id": 1,
- "description": "Una persona externa quiere llevarse a varios niños",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de un incidentes
| incidents required | integer Identificador del incidente |
{- "data": {
- "incident_id": 1,
- "user_id": 1,
- "url_video": null,
- "status": 1,
- "latitude": "37.421875199999995",
- "longitude": "-122.0851173",
- "catalog_incident_id": 1,
- "description": "Una persona externa quiere llevarse a varios niños",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}{- "data": [
- {
- "catalog_incident_id": 1,
- "title": "Agresión por parte de persona ajena",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Muestra todos los incidentes
| incidents required | integer Identificador del incidente |
{- "data": {
- "catalog_incident_id": 1,
- "title": "Agresión por parte de persona ajena",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Actualiza los datos de un catalogo incidentes
| incidents required | integer Identificador del incidente |
{- "data": {
- "catalog_incident_id": 1,
- "title": "Agresión por parte de persona ajena",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna los datos de la escuela, así como también datos adicionales para realizar un seguimiento de supervisión
| clave required | string CCT de la escuela |
{- "school": {
- "school_id": 21,
- "name": "Escuela publica",
- "cellphone": "6191111118",
- "status": 1,
- "colony": "Pendiente",
- "inside_number": "34",
- "outside_number": "12",
- "street": "Pendiente",
- "zipcode": "34188",
- "city_id": 254,
- "level": 5,
- "control": 1,
- "turn": 1,
- "clave": "10PJN0142Q",
- "sustenance": 1,
- "periode": "2019",
- "location": "Durango",
- "student_population": 600,
- "teaching_population": 200,
- "average_rating": 7,
- "average_absence": 0.25,
- "average_presence": 0.75,
- "total_absence": 2,
- "total_presence": 3,
- "maximum_student_capacity": 1000,
- "reserved_students_capacity": 100,
- "school_type_id": 1,
- "sector": "09",
- "zone": "015",
- "region": "100",
- "oci": "10EPR0374R",
- "current_cycle": "2021-2022",
- "education_plan_id": 1,
- "foundation_date": "2022-09-20",
- "geographical_scope": "1",
- "last_supervision": "1999-12-19 10:10:10",
- "latitude": "1999-12-19 10:10:10",
- "longitude": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}, - "total_users": 21,
- "total_users_trained": 21,
- "supervisor_user": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}Recupera el listado de preguntas y respuestas que una escuela responderá
| school_id required | integer Example: school_id=1 Identificador de la escuela |
| survey_type required | integer Example: survey_type=1 Tipo de encuesta 1.- Global 2.-Especifica |
| latitude required | integer Example: latitude=24.02991 Latitud |
| longitude required | integer Example: longitude=-104.68351 Longitud |
{- "questions": [
- {
- "question_id": 21,
- "school_id": 1,
- "question": "Cuenta con extacionamiento",
- "type": "1",
- "is_multiple": false,
- "deleted_at": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "cataloganswers": [
- {
- "catalog_answer_id": 21,
- "question_id": 23,
- "title": "Si",
- "deleted_at": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
]
}Registra las respuestas de las preguntas de una escuela
| school_id | number |
Array of objects |
{- "school_id": 1,
- "survey_answers": [
- {
- "question_id": 0,
- "answers": [
- "string"
]
}
]
}La pregunta requiere multiple respuestas
{- "message": "La pregunta requiere multiple respuestas",
- "status": 409,
- "code": 3401
}Retorna información de todas las escuelas referentes al proceso de supervisión
{- "school": [
- {
- "school_id": 1,
- "name": "UTD",
- "clave": 1,
- "last_supervision": "2019-09-12 23:23:23",
- "total_students": 800
}
], - "user": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}, - "total_user": 800,
- "total_user_trained": 800,
- "total_user_apk": 800
}Retorna informacion de seguimiento de una escuela en especifico
| school_id required | integer Identificador de la escuela |
{- "totals": {
- "parents": {
- "total": "102",
- "trained": "102",
- "app": "102"
}, - "professors": {
- "total": "102",
- "trained": "102",
- "app": "102"
}, - "assessors": {
- "total": "102",
- "trained": "102",
- "app": "102"
}, - "directors": {
- "total": "102",
- "trained": "102",
- "app": "102"
}, - "administrators": {
- "total": "102",
- "trained": "102",
- "app": "102"
}
}, - "users": {
- "parents": [
- {
- "user_id": "102",
- "name": "Pedro",
- "last_name": "Martinez",
- "second_last_name": "Gomez",
- "trained": true,
- "with_app": true
}
], - "professors": [
- {
- "user_id": "102",
- "name": "Pedro",
- "last_name": "Martinez",
- "second_last_name": "Gomez",
- "trained": true,
- "with_app": true
}
], - "assessors": [
- {
- "user_id": "102",
- "name": "Pedro",
- "last_name": "Martinez",
- "second_last_name": "Gomez",
- "trained": true,
- "with_app": true
}
], - "directors": [
- {
- "user_id": "102",
- "name": "Pedro",
- "last_name": "Martinez",
- "second_last_name": "Gomez",
- "trained": true,
- "with_app": true
}
], - "administrators": [
- {
- "user_id": "102",
- "name": "Pedro",
- "last_name": "Martinez",
- "second_last_name": "Gomez",
- "trained": true,
- "with_app": true
}
]
}, - "survey_answers": {
- "questions": [
- {
- "question_id": 21,
- "school_id": 1,
- "question": "Cuenta con extacionamiento",
- "type": "1",
- "is_multiple": false,
- "deleted_at": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "cataloganswer": [
- {
- "catalog_answer_id": 21,
- "question_id": 23,
- "title": "Si",
- "deleted_at": "1999-12-19 10:10:10",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "answers": [
- {
- "answer_id": 1,
- "question_id": 2,
- "school_id": 3,
- "supervisor_id": 4,
- "catalog_answer_id": 6,
- "answer": "Si, contamos con respuesta",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
]
}
}Retorna un listado de todos los encargos del sistema
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion del encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Actualiza los datos de un encargo
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Deshabilita un encargo
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}retorna el listado de tareas pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna el listado de actividades pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- { }
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna al profesor perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "professor_id": 1654,
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "subjects": 2,
- "groups": 1,
- "reports": 2,
- "assists_list_percent": 90,
- "last_score_created": "2022-09-20 12:16:38",
- "last_score_date": "2022-09-20 12:16:38"
}
}retorna la materia perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "subject_id": 0,
- "catalog_subject_id": 0,
- "professor_id": 0,
- "group_id": 0,
- "average_rating": 0,
- "total_absence": 0,
- "total_presence": 0,
- "last_assist_list": "string",
- "special": true,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}retorna la fuentes pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Agrega fuentes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
| source_catalog_id | integer |
| title | string |
| url_file | string |
| start | string |
| last | string |
[- {
- "source_catalog_id": 5,
- "title": "Titulo de la fuente",
- "start": "10:25",
- "last": "15:00"
}
]{- "data": [
- {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna el catalogo de accion perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "action_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el formato de entrega perteneciente a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": {
- "delivery_format_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna las fuentes del catálogo pertenecientes a un encargo enviado por parametro
| assignmentId required | integer Identificador del encargo |
{- "data": [
- {
- "source_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las acciones creadas
{- "data": [
- {
- "action_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la información de un registro de catálogo de acciones enviado por parametro
| catalogActionId required | integer Identificador del catalogo de acciones |
{- "data": {
- "action_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el listado de encargos pertenecientes a catalogo de accion enviado por parametro
| catalogActionId required | integer Identificador del catalogo de acciones |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las tareas creadas
{- "data": [
- {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Actualiza información de una tarea referentes a un encargo en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Retorna información de una tarea en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "homework_id": 1,
- "assignment_id": 1,
- "student_id": 1,
- "revision_status": 1,
- "delivered": true,
- "url_file": 1
}
}Retorna información del estudiante referente a una tarea en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "student_id": 35,
- "group_id": 40,
- "school_id": 21,
- "created_by": 401,
- "name": "Jorge Eduardo",
- "last_name": "Carrillo",
- "second_last_name": "Puentes",
- "cellphone": "6181111113",
- "folio": "1313113",
- "colony": "Pendiente",
- "inside_number": "123",
- "outside_number": "123",
- "street": "Pendiente",
- "zipcode": "123",
- "city_id": 256,
- "address_city_id": 3112,
- "status": 1,
- "has_special_groups": false,
- "average_rating": 9.7,
- "total_absence": 7,
- "total_presence": 8,
- "relationships": 2,
- "groups": 2,
- "amount_subjects": 8,
- "gender": 1,
- "date_birth": "1994-08-19",
- "curp": "XXXXXXXXXXXXXXX",
- "height": 170,
- "weight": 60,
- "size": 54,
- "observation": "El alumno es especial",
- "email": "alumno@eficaz.com",
- "cura": "AABB9408191",
- "is_indigenous": false,
- "is_foreign": false,
- "preschool_years": 3,
- "elementary_years": 5,
- "middle_years": 3,
- "highschool_years": 3,
- "has_scholar_grants": true,
- "uniform_size": "md",
- "is_immigrant": true,
- "school_modality": 1,
- "in_repetition": true,
- "in_wrong_degree": 8,
- "apc": false,
- "situation": "No Definido",
- "total_groups": 0,
- "average_ungraded_subjects": 10.5,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
}Retorna información de todas las notificacion referentes a una tarea en sistema
| homeworkId required | integer Identificador de la tarea |
{- "data": [
- {
- "notification_id": 0,
- "user_id": 0,
- "notice_id": 0,
- "student_id": 0,
- "status": 0,
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}retorna el encargo de una tarea enviada por parametro
| homeworkId required | integer Identificador de la tarea |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Retorna información de todas las notificaciones de tareas creadas
{- "data": [
- {
- "id": 1,
- "homework_id": 1,
- "parent_notice_id": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de una notificación de tarea en sistema
| homeworkNotificationId required | integer Identificador de la notificación de tarea |
{- "data": {
- "id": 1,
- "homework_id": 1,
- "parent_notice_id": 1
}
}Retorna información de todo el catálogo de fuentes en sistema
{- "data": [
- {
- "source_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un registro del catálogo de fuentes en sistema
| catalogSourceId required | integer Identificador del catalogo de fuentes |
{- "data": {
- "source_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el listado de encargos pertenecientes a un catálogo de fuente enviada por parametro
| catalogSourceId required | integer Identificador del catalogo de fuentes |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todo el catálogo de formato de entrega en sistema
{- "data": [
- {
- "delivery_format_catalog_id": 1,
- "title": 1,
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna un registro del catálogo de formato de entrega en sistema
| catalogDeliveryFormatId required | integer Identificador del catalogo de formatos de entrega |
{- "data": {
- "delivery_format_catalog_id": 1,
- "title": 1,
- "status": true
}
}retorna el listado de encargos pertenecientes a un catálogo de formato de entrega enviada por parametro
| catalogDeliveryFormatId required | integer Identificador del catalogo de formatos de entrega |
{- "data": [
- {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de todas las fuentes creadas
{- "data": [
- {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la informacion de una fuente enviada por parametro
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
}Actualiza información de una fuente en sistema
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
}Deshabilita una fuente
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "source_id": 1,
- "assignment_id": 1,
- "source_catalog_id": 1,
- "title": "Título de la fuente",
- "url_file": 1,
- "start": "20",
- "end": "80"
}
}retorna el encargo perteneciente a una fuente enviada por parametro
| sourceId required | integer Identificador de la fuente |
{- "data": {
- "assignment_id": 1,
- "activity_id": 1,
- "professor_id": 1,
- "subject_id": 1,
- "start_date": "10-09-2023 12:12:12",
- "delivery_date": "10-09-2023 12:12:12",
- "description": "Realizar un cuestionario de quimica omitiendo",
- "delivery_format_catalog_id": 10,
- "action_catalog_id": 10,
- "amount": 10,
- "unit": 10,
- "title": 10,
- "cancelled": true
}
}Retorna información de todos los recursos de importaciones
{- "data": [
- {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna información de una importacion
| imports required | integer Identificador de la importacion |
{- "data": {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
}Reintenta la actualizacion de una importacion fallida
| imports required | integer Identificador de la importacion |
| file | string <binary> |
{- "data": {
- "import_id": 1,
- "user_id": 1,
- "folio": 1,
- "file_name": "00123187-bdac-496b-b405-7de4a3f25c1b.csv",
- "location": "local",
- "status": 1,
- "import_type": "students",
- "created_at": "1999-12-19 10:10:10",
- "updated_at": "1999-12-19 10:10:10",
- "deleted_at": "1999-12-19 10:10:10",
- "created_by": 1,
- "update_by": 1
}
}Retorna información del usuario que creo una importacion
{- "data": {
- "enrollment": "0001",
- "name": "Eduardo Alonso",
- "last_name": "Escobar",
- "second_last_name": "Lozano",
- "email": "escobareduardotics@gmail.com",
- "cellphone": "6183453449",
- "colony": "Constitución",
- "inside_number": "1",
- "outside_number": "986",
- "street": "Constituyentes de Queretaro",
- "zipcode": "34188",
- "city_id": 10,
- "birth_city_id": 34432,
- "level_education": 0,
- "curp": "XXXX000000XXXXXX00",
- "rfc": null,
- "date_birth": "1994-08-09",
- "gender": "1",
- "is_trained": true,
- "is_stranger": true,
- "is_foreign": false,
- "is_immigrant": true,
- "is_indigenous": true,
- "user_id": 1,
- "credential_id": 1654,
- "school_id": 10,
- "has_smartphone": true,
- "send_sms": true,
- "country_code": "52",
- "group_id": "10000000000000000000",
- "created_by": 10,
- "updated_at": "2022-09-20 12:16:38",
- "created_at": "2022-09-20 12:16:38",
- "status": 1,
- "push_id": null,
- "push_token": null
}
}{- "data": [
- {
- "trace_catalog_id": 1,
- "type": 1,
- "category": 5,
- "title": "TRASLADO",
- "status": true
}
], - "meta": {
- "paginated": true,
- "current_page": 1,
- "last_page": 1,
- "per_page": 1,
- "total": 10
}
}Retorna la información de un tipo de rastro
| catalogtraceId required | integer Identificador del catálogo de rastros |
{- "data": {
- "trace_catalog_id": 1,
- "type": 1,
- "category": 5,
- "title": "TRASLADO",
- "status": true
}
}