Eficaz API Webservice (2.0.0)

Download OpenAPI specification:

Eficaz Webservice permite la gestión y control de instituciones escolares

Crear usuarios

Operaciones para crear todos los tipos de usuarios

Crear un padre

Crear un padre que al inicio puede no ser un trabajador de una escuela

Authorizations:
(clientCredentilLocalServerclientCredentilStaggingServer)
Request Body schema: multipart/form-data

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

email
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear un administrador

Crear un administrador que aun no cuenta con una escuela para administrar

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asigna un profesor

Registra un nuevo profesor que podra dar clases en algún grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asigina un asesor

Registra un nuevo asesor que podra gestionar los reportes de un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asigna un vosero

Registra un nuevo vosero que podra enviar avisos a todos los usuarios de eficaz

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asiginar un administrador

Registra un nuevo administrador que podra gestionar las operaciones de una escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asigina un padre

Registra un nuevo padre que podra ser gestionado por la escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asigna un director

Registra un nuevo director que podra observar las estadisticas de la escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear alumnos

Operaciones para la creación de alumnos

Crear y asigna un alumno a un grupo

Registra y asigna un nuevo alumno a un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear un alumno

Registra un nuevo alumno listo para ser asignado a un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Asignación de grupos

Operaciones para asignar un alumno a un grupo

Nombrar asistencia

Operaciones para nombrar lista de asistencia

Agregar una asistencia a un alumno

Nombrar asistencia a un solo alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Registra multiples asistencias

Registra un bloque de asistencias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Captura de calificaciones

Operaciones para capturar calificaciones

Agregar una calificación a un alumno

Captura una calificación a un solo alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Registrar o actualiza un bloque calificaciones

Registra un bloque de asistencias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Estadísticas

Operaciones para mostrar estadísticas de diferentes recursos

Utilidad

Operaciones que permite realizar ciertas tareas sobre el webservice

Verifica el estado del Webservice

Comprueba si el webservice esta disponible y si es capas de procesar solicitudes

Responses

Verifica si hay actualizaciones disponibles

Comprueba si hay actualizaciones disponibles para la aplicación movil

Request Body schema: multipart/form-data
required
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

Responses

Response samples

Content type
application/json
{
  • "allow": true,
  • "message": "string",
  • "improved": [
    ]
}

Comprueba contraseña

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

Authorizations:
(passportLocalServerpassportStaggingServer)
Request Body schema: multipart/form-data
required
password
required
string

Contraseña a verificar

Responses

Response samples

Content type
application/json
{
  • "message": "Contraseña incorrecta",
  • "status": "409",
  • "code": "3753"
}

Endpoint de prueba

Este endpoint puede ser usado para cualquier tipo de objetivo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Cuentas

Operaciones que trabajan sobre el usuario del token envido

Retorna informacion personal

Retorna la informacion personal del usuario perteneciente al token que se esta enviado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las licencias de un usuario

Retorna una lista de licencias perteneciente al token que se esta enviado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las notificaciones de un usuario

Retorna una lista de notificaciones que han sido enviadas por el sistema al usuario autenticado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las noticias de un usuario

Recupera un listado de noticias que han sido enviadas por el sistema al usuario autenticado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Parciales

Operaciones para trabajar sobre parciales

Retorna todos los parciales

Muestra todos los parciales disponibles

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un parcial

Retorna el parcial con el identificador envido por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un parcial

Actualiza los datos del parcial con el identificador enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Request Body schema: application/x-www-form-urlencoded
required
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un parcial

Elimina un parcial

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela de un parcial

Muestra la escuela del parcial

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las calificaciones de un parcial

Muestra todas las calificacaiones del parcial

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las asistencias de un parcial

Muestra muestra todas las asistencias del parcial

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las validaciones de un parcial

Muestra un listado de validaciones sobre las calificaciones que fueron creadas dentro del parcial enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear una validación

Crea una validación que autoriza el uso fiable de la calificaciones

path Parameters
partialId
required
integer

Identificador del parcial

Request Body schema: multipart/form-data
required
validation_level
required
integer

Nivel escolar de validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Administrativos

Los administradores son usuarios que se encargan de la gestion tenica de la escuela

Muestra un listado de administrativos

Muestra todos los administrativos del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un administrativos

Muestra un administrativos en especifico

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un administrativos

Actualiza todas las propiedades de un administrativos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un administrativos

Eliminar un administrativos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra una escuela

Muestra la escuela a la pertenece

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Working

Rutas que están en proceso de trabajo

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las licencias de trabajo de una escuela

Muestra el listado de licecias de usuario pueden operar en la escuela identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea una licencia de trabajo

Crea una licencia de trabajo

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los rastreos de alumnos de una escuela

Muestra el listado de rastreos de alumnos de la escuela enviada en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad donde esta ubicada la escuela

Muestra la ciudad donde esta ubicada la escuela identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los documentos de una escuela

Retorna uns lista de documentos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las validaciones de parciales de una escuela

Retorna las valdiaciones de parciales de la escuela enviad por parametro

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las importaciones de una escuela

Retorna las importaciones de la escuela enviad por parametro

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los idiomas de un alumno

Muestra una lista de idiomas habladas por el alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agregar un idioma a un alumno

Agregar un idioma al alumno envido por parametro

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar idioma de un alumno

Elimina la relacion de un idioma con un alumno

path Parameters
studentId
required
integer

Identificador del alumno

languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una lista de caracteristica

Muestra una lista de caracteristica que describen al alumno enviado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agregar una caracteristica

Crea una relacion de un alumno con una caracteristica

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una caracteristica de un alumno

Elimina la relacion de una caracteristica con un alumno

path Parameters
studentId
required
integer

Identificador del alumno

characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los documentos de un alumno

Muestra una lista de los documentos adjuntos al alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agrega un documento a un alumno

Crea un documento al alumno envido por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las redes sociales de sun alumno

Muestra una lista de las redes sociales pertenecientes al alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear una red social

Agregar una red social al alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el restreo de un alumno

Muestra el rastreo a traves varias escuelas del alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad de un alumno

Muestra la ciudad de nacimiento del alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las materias de un grupos

Muestra las materias que se imparten en ese grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las validaciones de un parcial

Muestra un listado de validaciones sobre las calificaciones que fueron creadas dentro del parcial enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
partialId
required
integer

Identificador del parcial

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear una validación

Crea una validación que autoriza el uso fiable de la calificaciones

path Parameters
partialId
required
integer

Identificador del parcial

Request Body schema: multipart/form-data
required
validation_level
required
integer

Nivel escolar de validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los idomas

Retorna una lista de lenjuages e idiomas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un idioma

Permite crear un nuevo idoma

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra una lenguaje

Retorna la informaicon del lenguaje enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un lenjuage

Modifica los valores de un lenguaje

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminan de lenguajes

Eliminar el lenjuage enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una lista de alumnos

Retorna una lista de alumnos que hablan el idioma enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todas las validaciones de calificaciones

Retorna una lista de validaciones de calificaciones

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una validación

Retorna la informaicon de la validación enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una validación

Permite actualizar los datos de una validación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una validación

Elimina una validación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el parcial de una validación

Retorna el parcial asociado a la validación enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario de una validación

Retorna el usuario que creo la validación enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las calificaciones de una validación

Retorna un listado de calificaciones validadas por identificador enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todas las caracteristicas

Retorna una lista de caracteristicas de alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea una caracteristica

Crea un caracteristica

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una caracteristica

Retorna la informaicon de la caracteristica enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una caracteristica

Actualiza los datos de la caracteristica enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una caracteristica

Elimina la caracteristica enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los alumnos de una caracteristica

Retorna una lista de alumnos con la caracteristica enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos los documentos

Retorna una lista de documentos del alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un documento

Retorna la informacion del documento enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un documento

Actualizar los datos de un documento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un documento

Actualizar un documento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna un alumno

Retorna el alumno asociado al documento enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas las redes sociales

Retorna una lista de redes sociales del alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una red social

Retorna la informacion de la red social enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una red social

Actualziar los datos de una red social

path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una red social

Elimina una red social

path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de la red social

Retorna el alumno asociado a la red social enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas las licencias

Retorna una lista de licencias de trabajo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una licencia

Retorna la informacion de la licencia enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una licencia

Actualiza los datos de una licencia

path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una licencia

Elimina una licencia

path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela de la licencia

Retorna la escuela asociada a la licencia enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario de la licencia

Retorna el usuario asociado a la licencia enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos loas rastros

Retorna una lista de rastros que los alumnos van dejando

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un rastro

Retorna la informacion del rastro enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un rastero

Actualiza los datos de un rastreo

path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un rastreo

Elimina un rastreo

path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de un rastreo

Retorna el alumno asociado al rastreo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela de un rastreo

Retorna la escuela asociada al rastreo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los estados

Retorna una lista de estados

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un estado

Retorna la informacion del estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un estado

Actualiza los datos de un estado

path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un estado

Elimina un estado

path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el pais de un estado

Retorna el pais al que pertenece el estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Retorna los municipios de un estado

Retorna el listado de municipios que pertenecen al estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Retorna todos los paises

Retorna una lista de paises

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un pais

Retorna la informacion del pais enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar in pais

Actualizar los datos de un pais

path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un pais

Actualziar los datos de un pais

path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los estados de un pais

Retorna una lista de estados que pertenecen al pais enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos las municipios

Retorna una lista de municipios

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un municipio

Retorna la informacion del municipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un municipio

Actualiza los datos del municipio

path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un municipio

Eliminar un municipio

path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el estado del municipio

Retorna el estado al que pertenece el minicipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas las ciudades de un municipio

Retorna la lista de ciudades que pertenecen al minicipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todas las ciudades

Retorna una lista de ciudades

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un ciudad

Retorna la informacion de la ciudad enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una ciudad

Actualiza los datos de la clidad

path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una ciudad

Eliminar una ciudad

path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el municipio de una ciudad

Retorna el municipio al que pertenecen la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los alumnos de una ciudad

Retorna el listado de alumnos que viven la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los usuarios de una ciudad

Retorna el listado de usuarios que viven la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuela de una ciudad

Retorna el listado de escuelas que estan ubicadas la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Modulo Tareas

Rutas que están en proceso de trabajo

Muestra los encargos de un profesor

Retorna un listado de todos los encargos de un profesor enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
professorId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea un encargo

Crea un encargo para un profesor

path Parameters
professorId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas los encargos

Retorna un listado de todos los encargos del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un encargo

Retorna la informacion del encargo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un recurso de encargo

Actualiza los datos de un encargo

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

cancelar encargo

Deshabilita un encargo

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra las tareas de un encargo

retorna el listado de tareas pertenecientes a un encargo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra las actividades de un encargo

retorna el listado de actividades pertenecientes a un encargo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra al profesor de un encargo

retorna al profesor perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra la materia de un encargo

retorna la materia perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra las fuentes de un encargo

retorna la fuentes pertenecientes a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agrega fuentes a un encargo

Agrega fuentes a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Request Body schema: application/json
required
Array
source_catalog_id
integer
title
string
url_file
string
start
string
last
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra el catalogo de accion de un encargo

retorna el catalogo de accion perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra el formato de entrega de un encargo

retorna el formato de entrega perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra las fuentes del catálogo de un encargo

retorna las fuentes del catálogo pertenecientes a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las acciones

Retorna información de todas las acciones creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un registro del catálogo de acciones en sistema

Retorna la información de un registro de catálogo de acciones enviado por parametro

path Parameters
catalogActionId
required
integer

Identificador del catalogo de acciones

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los encargos de un catalgo de accion

retorna el listado de encargos pertenecientes a catalogo de accion enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogActionId
required
integer

Identificador del catalogo de acciones

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas

Retorna información de todas las tareas creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Actualiza un recurso de tareas

Actualiza información de una tarea referentes a un encargo en sistema

path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra una tarea

Retorna información de una tarea en sistema

path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar el estudiante de una tarea

Retorna información del estudiante referente a una tarea en sistema

path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar todas las notificaciones de una tarea

Retorna información de todas las notificacion referentes a una tarea en sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra el encargo de una tarea

retorna el encargo de una tarea enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar todas las notificaciones de tareas

Retorna información de todas las notificaciones de tareas creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una notificación de tarea

Retorna información de una notificación de tarea en sistema

path Parameters
homeworkNotificationId
required
integer

Identificador de la notificación de tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar el catálogo de fuentes

Retorna información de todo el catálogo de fuentes en sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un registro del catálogo de fuentes en sistema

Retorna un registro del catálogo de fuentes en sistema

path Parameters
catalogSourceId
required
integer

Identificador del catalogo de fuentes

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los encargos de un catálogo de fuente

retorna el listado de encargos pertenecientes a un catálogo de fuente enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogSourceId
required
integer

Identificador del catalogo de fuentes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar el catálogo de formato de entrega

Retorna información de todo el catálogo de formato de entrega en sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un registro del catálogo de formato de entrega en sistema

Retorna un registro del catálogo de formato de entrega en sistema

path Parameters
catalogDeliveryFormatId
required
integer

Identificador del catalogo de formatos de entrega

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los encargos de un catálogo de formato de entrega

retorna el listado de encargos pertenecientes a un catálogo de formato de entrega enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogDeliveryFormatId
required
integer

Identificador del catalogo de formatos de entrega

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las fuentes

Retorna información de todas las fuentes creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una fuente

Retorna la informacion de una fuente enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un recurso de fuente

Actualiza información de una fuente en sistema

path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

cancelar fuente

Deshabilita una fuente

path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra el encargo de una fuente

retorna el encargo perteneciente a una fuente enviada por parametro

path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crea multiples encargos sobre una sola materias

Crea multiples recursos de Encargo sobre una sola materia

path Parameters
professorId
required
integer

Identificador del usuario

subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas de un profesor

Retorna información de todas las tareas referentes a un profesor

path Parameters
professorId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todos los encargos de una actividad

Retorna información de todos los encargos referentes a una actividad

Responses

Retornar todas las tareas de una actividad

Retorna información de todas las tareas referentes a una actividad

Responses

Retornar todas las notificacion de una actividad

Retorna información de todas las notificacaiones referentes a una active

Responses

Retornar todos los encargos de una materia

Retorna información de todos los encargos referentes a una materia

path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas de una materia

Retorna información de todas las tareas referente a una materia

path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todos los encargos de un alumno

Retorna información de todos los encargos referentes a un alumno

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas de un alumno

Retorna información de todas las tareas referentes a un alumno

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar la tareas de una notificación

Retorna información de una tarea referente a una notificacaion

path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar todas las tareas de un padre

Retorna información de todas las tareas referentes a un padre

path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Modulo de Pagos

Rutas para el modulo de pagos

Retorna los convenios que tiene un usuario

Retorna los convenios que tiene un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los pagos que tiene un usuario

Retorna los pagos que tiene un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que tengan ese catalogo de conceptos

Retorna las escuelas que tengan ese catalogo de conceptos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que tengan ese catalogo de descuentos

Retorna las escuelas que tengan ese catalogo de descuentos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que tengan ese catalogo de recargos

Retorna las escuelas que tengan ese catalogo de recargos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos los conceptos del catalogo

Muestra todos los conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un catalogo de conceptos

Muestra todos los conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un catalogo de conceptos

Eliminar un catalogo de conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un concepto del catalogo

Modificar los valores de un concepto del catalogo

path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Request Body schema: application/json
required
Array
concept
string
active
boolean
value
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo catalogo

Agrega nuevo catalogo

path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema: application/json
required
Array
concept
string
active
boolean
value
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los conceptos que contenga el id_catalogconcept

Muestra todos los conceptos que contengan el id_catalogconcept específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que contenga el id_catalogconcept

Muestra todos las escuelas que contengan el id_catalogconcept específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos los conceptos

Muestra todos los conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un concepto

Muestra un concepto

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un concepto

Eliminar un concepto

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un concepto

Modificar los valores de un concepto

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
description
string
limit_date
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo concepto

Agrega un nuevo concepto

path Parameters
studentId
required
integer

Identificador del alumno

Request Body schema: application/json
required
Array
description
string
limit_date
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de conceptos que corresponda ese concepto

Muestra un catalogo de conceptos al que corresponda el concepto específica

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el convenio que corresponda ese concepto

Muestra un convenio al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el pago que corresponda ese concepto

Muestra un pago al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno que corresponda ese concepto

Muestra un alumno al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los descuentos del catalogo

Muestra todos los descuentos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un descuento del catalogo

Muestra un descuento del catalogo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un catalogo de descuentos

Eliminar un catalogo de descuentos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un descuento del catalogo

Modificar los valores de un descuento del catalogo

path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo catalogo de descuentos

Agrega nuevo catalogo de descuentos

path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los descuentos del catalogo de descuentos segun el ID

Muestra los descuentos del catalogo de descuentos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la escuela correspondiente al catalogo de descuentos segun el ID

Muestra la escuela correspondiente al catalogo de descuentos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los descuentos

Muestra todos los descuentos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un descuento

Muestra un descuento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un descuento

Eliminar un descuento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un descuento

Modificar los valores de un descuento

path Parameters
discountId
required
integer

Identificador del descuento

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo descuento

Agrega un nuevo descuento

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el descuento que corresponda ese concepto

Muestra un descuento al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de descuentos que tiene un descuento

Muestra el catalogo de descuentso que tiene un descuento segun el ID del descuento especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto que tiene ese descuento

Muestra el concepto que tiene un descuento segun el ID del descuento especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los recargos del catalogo

Muestra todos los recargos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un recargo del catalogo

Muestra un recargo del catalogo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un catalogo de recargos

Eliminar un catalogo de recargos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un recargo del catalogo

Modificar los valores de un recargo del catalogo

path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo catalogo de recargos

Agrega nuevo catalogo de recargos

path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los recargos del catalogo de recargos segun el ID

Muestra los recargos del catalogo de recargos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la escuela correspondiente al catalogo de recargos segun el ID

Muestra la escuela correspondiente al catalogo de recargos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los recargos

Muestra todos los recargos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un recargo

Muestra un recargo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un recargo

Eliminar un recargo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un recargo

Modificar los valores de un recargo

path Parameters
surchargeId
required
integer

Identificador del recargo

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo recargo

Agrega un nuevo recargo

path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el recargo que corresponda ese concepto

Muestra un recargo al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de recargos que tiene un recargo

Muestra el catalogo de recargos que tiene un recargo segun el ID del descuento especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto que tiene ese recargo

Muestra el concepto que tiene un recargo segun el ID del recargo especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los convenios

Muestra todos los convenios

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un convenio

Muestra un convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un Convenio

Eliminar un Convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un convenio

Modificar los valores de un convenio

path Parameters
agreementId
required
integer

Identificador del convenio

Request Body schema: application/json
required
Array
term
integer
term_type
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto con el ID del convenio correspondiente

Muestra el concepto que tiene el ID del convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario según el ID del convenio correspondiente

Muestra el usuario que tiene el ID del convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo convenio

Agrega un nuevo convenio

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
term
integer
term_type
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo convenio

Agrega un nuevo convenio

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
term
integer
term_type
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos los pagos

Muestra todos los pagos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un pago

Muestra un pago

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un Pago

Eliminar un Pago

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un Pago

Modificar los valores de un Pago

path Parameters
paymentId
required
integer

Identificador del pago

Request Body schema: application/json
required
Array
amount
number
payment_method
integer
canceled
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto que tiene ese pago

Muestra el concepto que tiene un pago segun el ID del pago especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario que tiene ese pago

Muestra el usuario que tiene un pago segun el ID del pago especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo Pago

Agrega un nuevo Pago

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
amount
number
payment_method
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo Pago

Agrega un nuevo Pago

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
amount
number
payment_method
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los conceptos asignados de un alumno

Muestra los conceptos asignados de un alumno segun su student_id

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Configuraciones del servicio

Retorna todas las configuraciones

Retorna la lista de configuraciones que pueden alterar el funcionamiento general de eficaz

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una configuración

Retorna la configuración especificada en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
configurationId
required
integer

Identificador de la configuracion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Usuarios

Retorna todos los usuario

Retorna un listado de todos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un usuario

Retorna los datos de un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza datos importantes usuario

Actualiza los datos de un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Request Body schema: application/x-www-form-urlencoded
optional
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deshabilita un usuario

Deshabilita un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una lista de noticias

Retorna un listado de noticias que el sistema a enviado al usuario identificado en ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una lista de notificaciones

Retorna un listado de notificaciones que el sistema a enviado al usuario identificado en ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un listado de licencias de trabajo

Muestra un listado de licencias de trabajo donde el usuario identificado en la ruta puede operar

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un listado de validaciones

Muestra un listado de validacions creadas por el usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los convenios que tiene un usuario

Retorna los convenios que tiene un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los pagos que tiene un usuario

Retorna los pagos que tiene un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea un incidente

Crea un incidente

Authorizations:
(passportLocalServerpassportStaggingServer)
Request Body schema: multipart/form-data
required
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crea una Importación

Crea la Importación de un archivo enviado por un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Request Body schema: multipart/form-data
required
file
string <binary>
import_type
string
location
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las importaciones de un usuario

Retorna todas las importaciones creadas por un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Padres

Retorna todos los padres

Retorna la lista de padres

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un padre

Crear un padre que al inicio puede no ser un trabajador de una escuela

Authorizations:
(clientCredentilLocalServerclientCredentilStaggingServer)
Request Body schema: multipart/form-data

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

email
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna un padre

Retorna el padres especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un padre

Actualiza el padre identificado en la ruta, aqui no es posible cambiar de usuario ni de telefono

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Request Body schema: multipart/form-data
name
string <= 100 characters
last_name
string <= 100 characters
second_last_name
string <= 100 characters
email
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Da de baja un padre

Da de baja el padre que esta identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una lista de notificaciones

Retorna la lista de notificaciones del padre identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una lista de noticias

Retorna la lista de noticias del padre identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una lista de parentescos

Retorna la lista de parentescos del padre identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una lista de alumnos

Retorna la lista de alumnos del padre identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar todas las tareas de un padre

Retorna información de todas las tareas referentes a un padre

path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Directores

Retorna una lista de directores

Retorna la lista de directores

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un director

Retorna el director especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un director

Actualiza el director especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Request Body schema: multipart/form-data
name
string <= 100 characters
last_name
string <= 100 characters
second_last_name
string <= 100 characters
email
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Da de baja un director

Da de baja el director especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una escuela

Retorna la escuela de el director especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Profesores

Retorna todos los profesores

Retorna una lista de todos los profesores del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un profesor

Retorna el profesor que esta especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un profesor

Actualiza el profesor que esta especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Da de baja un profesor

Da de baja el profesor que esta especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela del profesor

Retorna la escuela a la que pertenece el profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los reportes de un profesor

Retorna la lista de reportes creados pertenece el profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las noticias de un profesor

Retorna la lista de noticias enviadas al profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las notificaciones de un profesor

Retorna la lista de notificaciones enviadas al profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos los permisos de un profesor

Retorna la lista de permisos concedidos por el profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Retorna la lista de permisos concedidos a un usuario

Retorna la lista de permisos concedidos al profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Retorna los grupos de un profesor

Retorna la lista de grupos en los que el profesor especificado en la ruta importa clases

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las materias de un profesor

Retorna la lista de materias que importe el profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea una materia

Crea una materia al profesor especificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crea un permisos

Crea una permiso para conceder el acceso a otros profesores

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

query Parameters
guestId
required
integer

Identificador del usuario que podra usar el acceso

Responses

Retorna la ciudad de nacimiento

Retorna la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los incidentes del profesor envido por parametro

Retorna los incidentes de un profesor

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra los encargos de un profesor

Retorna un listado de todos los encargos de un profesor enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
professorId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea un encargo

Crea un encargo para un profesor

path Parameters
professorId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crea multiples encargos sobre una sola materias

Crea multiples recursos de Encargo sobre una sola materia

path Parameters
professorId
required
integer

Identificador del usuario

subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas de un profesor

Retorna información de todas las tareas referentes a un profesor

path Parameters
professorId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Asesores

Retorna todos asesores

Muestra todos los asesores del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un asesor

Muestra un asesor en especifico

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un asesor

Actualiza todas las propiedades de un asesor

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un asesor

Eliminar un asesor

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las notificacaiones de un asesor

Muestra las notificacaiones

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los expedientes de un asesor

Muestra los expedientes asignados al asesor

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los avisos de u nasesor

Muestra los avisos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la escuela de un asesor

Muestra la escuela a la que pertenece el asesor

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los grupo de un alumno

Muestra los grupos asesorados

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Voseros

Retorna todos voseros

Muestra todos los voseros del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un voseros

Muestra un voseros en especifico

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un voseros

Actualiza todas las propiedades de un voseros

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un voseros

Eliminar un voseros

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las noticias de un vosero

Muestra las noticias creadas por el voseros

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la escuela del vosero

Muestra las escuela a la que pertenece el usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Administradores

Retorna todos los administradores

Muestra todos los administradores del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un administrador

Crear un administrador que aun no cuenta con una escuela para administrar

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna un administrador

Muestra un administrador en especifico

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un administrador

Actualiza todas las propiedades de un administrador

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un administrador

Eliminar un administrador

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela de un administrador

Muestra la escuela que administra

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crea una escuela

Crea una nueva escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Muestra la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Escuelas

Retorna todas las escuelas

Muestra todos los escuelas del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

retorna una escuela

Muestra la escuela con el identificador enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una escuela

Actualiza todas las propiedades de una escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una escuela

Eliminar una escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los profesores de una escuela

Muestra los profesores de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear y asigna un profesor

Registra un nuevo profesor que podra dar clases en algún grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los asesores de una escuela

Retorna todos los asesores de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear y asigina un asesor

Registra un nuevo asesor que podra gestionar los reportes de un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los voseros de una escuela

Muestra los voseros de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear y asigna un vosero

Registra un nuevo vosero que podra enviar avisos a todos los usuarios de eficaz

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todos oos usuarios

Muestra los voseros de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los administradores de una escuela

Muestra un administradores de la escuelas enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear y asiginar un administrador

Registra un nuevo administrador que podra gestionar las operaciones de una escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los grupos de una escuela

Muestra los grupos de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un grupo

Crear un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema:
required
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

Responses

Request samples

Content type
{
  • "grade": 1,
  • "group": "A",
  • "turn": 1,
  • "level": 3,
  • "special": 1,
  • "annexed": false,
  • "annexed_name": "Tecnologia II",
  • "combined": 3
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear y asigna un alumno a un grupo

Registra y asigna un nuevo alumno a un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las configuraciones de una escuela

Muestra las configuraciones de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna el catalogo de materias de una escuela

Muestra un catalogo de materias de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un catalogo de materias

Crear un catalogo de materias

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los alumnos de una escuela

Muestra alumnos en especifico

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un alumno

Registra un nuevo alumno listo para ser asignado a un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los avisos de una escuela

Muestra los avisos de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las materias de una escuela

Muestra las materias de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los reportes de una escuela

Muestra los reportes de alumno de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las relaciones de una escuela

Muestra las relaciones entre un usuario y un alumno de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los parciales de una escuela

Muestra los parciales de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un parcial

Crear parciales

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de reportes de una escuela

Muestra el catalogo de reportes de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un catalogo de reporte

Crear catalogo de reporte

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los padres de una escuela

Muestra los padres de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear y asigina un padre

Registra un nuevo padre que podra ser gestionado por la escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las actividades de una escuela

Muestra las actividades de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear actividades

Crea actividades del calendario escolar

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

Retorna los directores de una escuela

Muestra los directores de la escuela envida por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear y asigna un director

Registra un nuevo director que podra observar las estadisticas de la escuela

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los cortes de ciclo de una escuela

Muestra cortes de ciclos de la escuela enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un ciclo

Crea corte un corte de ciclos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las licencias de trabajo de una escuela

Muestra el listado de licecias de usuario pueden operar en la escuela identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea una licencia de trabajo

Crea una licencia de trabajo

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los rastreos de alumnos de una escuela

Muestra el listado de rastreos de alumnos de la escuela enviada en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad donde esta ubicada la escuela

Muestra la ciudad donde esta ubicada la escuela identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los documentos de una escuela

Retorna uns lista de documentos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que tengan ese catalogo de conceptos

Retorna las escuelas que tengan ese catalogo de conceptos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que tengan ese catalogo de descuentos

Retorna las escuelas que tengan ese catalogo de descuentos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que tengan ese catalogo de recargos

Retorna las escuelas que tengan ese catalogo de recargos

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las validaciones de parciales de una escuela

Retorna las valdiaciones de parciales de la escuela enviad por parametro

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las importaciones de una escuela

Retorna las importaciones de la escuela enviad por parametro

path Parameters
schoolId
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Asignacion de grupos

Crear y asigna un alumno a un grupo

Registra y asigna un nuevo alumno a un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
schoolId
required
integer

Identificador de la escuela

groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Asignar un grupo principal a un alumno

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

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cambiar de grupo

Cambia grupos de un alumno, ya sea principal o especial, si el alumno ya cuenta con el grupo enviado resultara en un error

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Ajustes

Muestra todos los ajustes

Muestra todos los ajustes de todas las escuelas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un ajuste

Muestra los datos del ajuste enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
settingId
required
integer

Identificador de la configuracion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un ajuste

Modificar los valores del ajuste enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
settingId
required
integer

Identificador de la configuracion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela del ajuste

Muestra la escuela del ajuste enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
settingId
required
integer

Identificador de la configuracion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catalogo Conceptos

Retorna todos los conceptos del catalogo

Muestra todos los conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un catalogo de conceptos

Muestra todos los conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un catalogo de conceptos

Eliminar un catalogo de conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un concepto del catalogo

Modificar los valores de un concepto del catalogo

path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Request Body schema: application/json
required
Array
concept
string
active
boolean
value
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo catalogo

Agrega nuevo catalogo

path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema: application/json
required
Array
concept
string
active
boolean
value
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los conceptos que contenga el id_catalogconcept

Muestra todos los conceptos que contengan el id_catalogconcept específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuelas que contenga el id_catalogconcept

Muestra todos las escuelas que contengan el id_catalogconcept específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogConceptId
required
integer

Identificador del catalogo de conceptos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Conceptos

Retorna todos los conceptos

Muestra todos los conceptos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un concepto

Muestra un concepto

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un concepto

Eliminar un concepto

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un concepto

Modificar los valores de un concepto

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
description
string
limit_date
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo concepto

Agrega un nuevo concepto

path Parameters
studentId
required
integer

Identificador del alumno

Request Body schema: application/json
required
Array
description
string
limit_date
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de conceptos que corresponda ese concepto

Muestra un catalogo de conceptos al que corresponda el concepto específica

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el convenio que corresponda ese concepto

Muestra un convenio al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el pago que corresponda ese concepto

Muestra un pago al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno que corresponda ese concepto

Muestra un alumno al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el descuento que corresponda ese concepto

Muestra un descuento al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
conceptId
required
integer

Identificador del concepto

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el recargo que corresponda ese concepto

Muestra un recargo al que corresponda el concepto específicado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catalogo Descuentos

Retorna todos los descuentos del catalogo

Muestra todos los descuentos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un descuento del catalogo

Muestra un descuento del catalogo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un catalogo de descuentos

Eliminar un catalogo de descuentos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un descuento del catalogo

Modificar los valores de un descuento del catalogo

path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo catalogo de descuentos

Agrega nuevo catalogo de descuentos

path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los descuentos del catalogo de descuentos segun el ID

Muestra los descuentos del catalogo de descuentos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la escuela correspondiente al catalogo de descuentos segun el ID

Muestra la escuela correspondiente al catalogo de descuentos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogDiscountId
required
integer

Identificador del catalogo de descuentos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Descuentos

Retorna todos los descuentos

Muestra todos los descuentos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un descuento

Muestra un descuento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un descuento

Eliminar un descuento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un descuento

Modificar los valores de un descuento

path Parameters
discountId
required
integer

Identificador del descuento

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo descuento

Agrega un nuevo descuento

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de descuentos que tiene un descuento

Muestra el catalogo de descuentso que tiene un descuento segun el ID del descuento especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto que tiene ese descuento

Muestra el concepto que tiene un descuento segun el ID del descuento especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
discountId
required
integer

Identificador del descuento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catalogo Recargos

Retorna todos los recargos del catalogo

Muestra todos los recargos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un recargo del catalogo

Muestra un recargo del catalogo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un catalogo de recargos

Eliminar un catalogo de recargos

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un recargo del catalogo

Modificar los valores de un recargo del catalogo

path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo catalogo de recargos

Agrega nuevo catalogo de recargos

path Parameters
schoolId
required
integer

Identificador de la escuela

Request Body schema: application/json
required
Array
title
string
value
number
value_modality
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los recargos del catalogo de recargos segun el ID

Muestra los recargos del catalogo de recargos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la escuela correspondiente al catalogo de recargos segun el ID

Muestra la escuela correspondiente al catalogo de recargos segun el ID especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Recargos

Retorna todos los recargos

Muestra todos los recargos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un recargo

Muestra un recargo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un recargo

Eliminar un recargo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un recargo

Modificar los valores de un recargo

path Parameters
surchargeId
required
integer

Identificador del recargo

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo recargo

Agrega un nuevo recargo

path Parameters
CatalogSurchargeId
required
integer

Identificador del catalogo de recargos

Request Body schema: application/json
required
Array
description
string
amount
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de recargos que tiene un recargo

Muestra el catalogo de recargos que tiene un recargo segun el ID del descuento especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto que tiene ese recargo

Muestra el concepto que tiene un recargo segun el ID del recargo especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
surchargeId
required
integer

Identificador del recargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Convenios

Retorna todos los convenios

Muestra todos los convenios

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un convenio

Muestra un convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un Convenio

Eliminar un Convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un convenio

Modificar los valores de un convenio

path Parameters
agreementId
required
integer

Identificador del convenio

Request Body schema: application/json
required
Array
term
integer
term_type
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto con el ID del convenio correspondiente

Muestra el concepto que tiene el ID del convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario según el ID del convenio correspondiente

Muestra el usuario que tiene el ID del convenio

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
agreementId
required
integer

Identificador del convenio

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo convenio

Agrega un nuevo convenio

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
term
integer
term_type
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo convenio

Agrega un nuevo convenio

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
term
integer
term_type
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Pagos

Retorna todos los pagos

Muestra todos los pagos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un pago

Muestra un pago

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un Pago

Eliminar un Pago

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un Pago

Modificar los valores de un Pago

path Parameters
paymentId
required
integer

Identificador del pago

Request Body schema: application/json
required
Array
amount
number
payment_method
integer
canceled
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el concepto que tiene ese pago

Muestra el concepto que tiene un pago segun el ID del pago especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario que tiene ese pago

Muestra el usuario que tiene un pago segun el ID del pago especificado

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
paymentId
required
integer

Identificador del pago

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo Pago

Agrega un nuevo Pago

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
amount
number
payment_method
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agrega un nuevo Pago

Agrega un nuevo Pago

path Parameters
conceptId
required
integer

Identificador del concepto

Request Body schema: application/json
required
Array
amount
number
payment_method
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Alumnos

Retorna todos los alumnos

Muestra todos los alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un alumno

Muestra los datos el alumno enviados por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un alumno

Modificar los valores del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Da de baja un alumno

Da de baja un alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los conceptos asignados de un alumno

Muestra los conceptos asignados de un alumno segun su student_id

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear una relacion

Crea una relación entre padre y alumno, sí el alumno tiene notificaciones eliminadas estas serán agregadas al nuevo padre

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los padres de un alumno

Muestra los padres del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Eliminar una relacion

Elimina la relacion entre un padre y un alumno, pero esto no elimina las notificaciones, que seran agregadas a la siguiente relacion creada

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas las relaciones de una alumno

Muestra las relaciones del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos los expedientes de un alumno

Muestra los expedientes del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un expediente

Crear expedientes a un alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los profesores de un alumno

Muestra los profesores que dan clase al alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los reportes de un alumno

Muestra los reportes del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una escuela

Muestra la escuela a la que pertenece el alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el grupo principal de un alumno

Muestra el grupos principal del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Asignar un grupo principal a un alumno

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

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cambiar de grupo

Cambia grupos de un alumno, ya sea principal o especial, si el alumno ya cuenta con el grupo enviado resultara en un error

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Quitar un grupo de un alumno

Quita el grupo al alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los grupos especiales de un alumno

Muestra los grupos especiales del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las calificaciones de un alumno

Muestra las calificaciones del alumno envido por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las asistencias de un alumno

Muestra las asistencias del alumno enviadas por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las materias de un alumno

Muestra las materias del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agregar materia a un alumno

Agregar una materia al alumno enviado por parametro, tener cuidado de que la materia pertenesca a alguno de los grupos que pertenecen al alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una materia de un alumno Deprecated

Quitar materias del alumno enviado por parametro y deshabilita sus asistencias

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agregar una asistencia a un alumno

Nombrar asistencia a un solo alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Agregar una calificación a un alumno

Captura una calificación a un solo alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las notificaciones de un alumno

Muestra las notificaciones del alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agregar un reporte a un alumno

Agregar un reporte al alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los idiomas de un alumno

Muestra una lista de idiomas habladas por el alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agregar un idioma a un alumno

Agregar un idioma al alumno envido por parametro

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar idioma de un alumno

Elimina la relacion de un idioma con un alumno

path Parameters
studentId
required
integer

Identificador del alumno

languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una lista de caracteristica

Muestra una lista de caracteristica que describen al alumno enviado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agregar una caracteristica

Crea una relacion de un alumno con una caracteristica

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una caracteristica de un alumno

Elimina la relacion de una caracteristica con un alumno

path Parameters
studentId
required
integer

Identificador del alumno

characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los documentos de un alumno

Muestra una lista de los documentos adjuntos al alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agrega un documento a un alumno

Crea un documento al alumno envido por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las redes sociales de sun alumno

Muestra una lista de las redes sociales pertenecientes al alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear una red social

Agregar una red social al alumno enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el restreo de un alumno

Muestra el rastreo a traves varias escuelas del alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad de un alumno

Muestra la ciudad de nacimiento del alumno identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar todos los encargos de un alumno

Retorna información de todos los encargos referentes a un alumno

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas de un alumno

Retorna información de todas las tareas referentes a un alumno

path Parameters
studentId
required
integer

Identificador del alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Relaciones

Retorna todas relaciones

Muestra todas las relaciones

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un relacion

Muestra los datos de la relacion enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
relationshipId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un relacion

Modificar los datos de la relacion enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
relationshipId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una relacion

Elimina relacion de padres y un alumno

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
relationshipId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de una relacion

Muestra el alumno de la relacion enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
relationshipId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el padre de una relacion

Muestra el padre de la relacion enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
relationshipId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catalogo reportes

Retorna todo el catalogo de reportes

Muestra todo el catalogo de reportes

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un catalogo de reporte

Crear un catalogo de reporte

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra un catalogo de reporte

Muestra los datos de catalogo de report enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportcatalogId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un catalogo

Modificar los valores de catalogo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportcatalogId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un catalogo

Elimina un catalogo de reporte

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportcatalogId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los reportes del catalogo de reportes

Muestra los reportes del catalogo de reportes enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportcatalogId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra escuelas

Muestra la escuela del reporte envido por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportcatalogId
required
integer

Identificador de la relacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Expedientes

Retorna todos los expedientes

Muestra todas los expedientes

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un expediente

Muestra los datos del expediente envido por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un expediente

Modificar los valores de un expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un expediente

Elimina un expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los reportes de un expediente

Muestra reportes que le pertenece el expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna el alumno de un expediente

Muestra a que alumno le pertenece el expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el asesores del expediente

Muestra a que asesor le pertenece el expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las notas del expediente

Muestra notas que pertenecen al expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear una nota

Crear una nota

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear un reporte a un alumno

Agergar un reporte a un expediente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
fileId
required
integer

Identificador del expediente

userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reportes

Retorna todos los reportes

Muestra todas los reportes

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un reporte

Muestra los datos del reporte enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un reporte

Modificar los valores de un reporte

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un reporte

Elimina un reporte

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el expediente de un reporte

Muestra los datos del expediente pertenece al reprote enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el profesores de un reporte

Muestra cual profesor creo el reporte

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo del reporte de un reporte

Muestra a que catalogo de reporte pertenecee

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
reportId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Notificaciones

Retorna todas las notificaciones

Muestra todas las notificaciones

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una notificacion

Muestra los datos de la notificacion enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una notificacion

Modificar los valores de una notificacion

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el aviso de una notificacion

Muestra a que aviso pertenecee

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario del una notificacion

Muestra que usuario pertenece la notificacion

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de una notificacion

Muestra a que alumno pertenece

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar la tareas de una notificación

Retorna información de una tarea referente a una notificacaion

path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Avisos

Retorna todos los avisos

Muestra todas los avisos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un aviso

Muestra los datos del aviso enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un aviso

Modificar los valores de un aviso

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna toda notificaciones de un aviso

Muestra un listado de notificaciones

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna el usuarios de un aviso

Muestra el usuario que emitio en aviso enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la notificación de tarea de un aviso

Muestra la notificación de tarea que pertenece al aviso

path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Permisos

Muestra permisos

Muestra todos los permisos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Muestra un permiso

Muestra un permiso

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Actualizar un permiso

Modificar los valores de un permiso

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Eliminar un permiso

Eliminar un permiso

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Muestra usuarios

Muestra el propietario del permiso

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Muestra usuarios

Muestra el usuario al que se le concedio el permiso

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Catalogo de materias

Retorna todo el catalogo de materias

Muestra todos el catalogo de materias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un catalogo de materias

Muestra los datos del catalogo de materias enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectcatalogId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un catalogo de materia

Modificar los valores de un catalogo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectcatalogId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuelas de un catalogo de materias

Muestra la escuela a la que pertenece el catalogo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectcatalogId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar las materias de un catalogo materias

Muestra las materias del catalogo de materias enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectcatalogId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Materias

Retorna todas las materias

Muestra todas las materias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear materias

Crea multiples materias para un grupo especifico

Authorizations:
(passportLocalServerpassportStaggingServer)
Request Body schema: multipart/form-data
required
group_id
integer <integer>
subjects
Array of arrays

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una materia

Muestra una materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una materia

Modificar los valores de una materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una materia

Elimina una materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el catalogo de una materia

Muestra el catalogo de la materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el profesores de una materia

Muestra el profesor que imparte la materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las asistencias de una materia

Muestra las asistencias de la materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las calificaciones de una materia

Muestra las calificacaiones de la materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los alumnos de una materia

Muestra los alumnos que acuden a esa materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna el grupo de la materia

Muestra el grupo en el que se da la materia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las materias de un grupos

Muestra las materias que se imparten en ese grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Elimina las materias de un grupos

Elimina multiples materias que se imparten en un grupo especificado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Request Body schema: multipart/form-data
required
subjects
Array of arrays

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todos los encargos de una materia

Retorna información de todos los encargos referentes a una materia

path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar todas las tareas de una materia

Retorna información de todas las tareas referente a una materia

path Parameters
subjectId
required
integer

Identificador de la materia

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Grupos

Retorna todos los grupos

Muestra todas los grupos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un grupo

Muestra los datos del grupo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una grupo

Modificar los valores de una grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar la escuela de un grupo

Muestra la escuela a la que pertenece el grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los alumnos de un grupos

Muestra los estudiantes del grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las materias de un grupos

Muestra las materias que se imparten en ese grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna el asesore de un grupo

Muestra al asesor del grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Asigna un asesor a un grupo

Asigana o cambia el asesor de un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los expedientes de un grupo

Muestra los expedientes de alumnos que pertenescan a ese grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las asistencias de un grupo

Muestra las asistencias de alumnos que pertenescan a ese grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las calificaciones de un grupo

Muestra las calificacaiones de alumnos que pertenescan a ese grupo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Asistencias

Retornar todas las asistencias

Muestra todas las asistencias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Registra multiples asistencias

Registra un bloque de asistencias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Actualizar una asistencia

Modificar los valores de una asistencia

Authorizations:
(passportLocalServerpassportStaggingServer)
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "update": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una asistencia

Muestra los datos de una asistencia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assistId
required
integer

Identificador de la asistencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumnos de una asistencia

Muestra el alumno de la asistencia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la materias de una asistencia

Muestra la materia de la asistencia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el parcial de una asistencia

Muestra el parcial en donde se realizo la falta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calificaciones

Retorna todas las calificaciones

Muestra todas las calificaciones

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Registrar o actualiza un bloque calificaciones

Registra un bloque de asistencias

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una calificación

Muestra una calificación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una calificación

Modificar los valores de una asistencia

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de una calificación

Muestra el alumno de la calificación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
calificationId
required
integer

Identificador de la calificación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la materia de una calificación

Muestra la materia de la calificación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el parciales de una calificación

Muestra el parcial en donde se realizo la calificación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Notas

Retornar todas las notas

Muestra todas las notas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una nota

Muestra una nota

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noteId
required
integer

Identificador de la nota

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una nota

Modificar los valores de una nota

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noteId
required
integer

Identificador de la nota

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una nota

Elimina una nota

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noteId
required
integer

Identificador de la nota

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el expediente de una nota

Muestra el expediente al que pertenece la nota

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noteId
required
integer

Identificador de la nota

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actividades

Retornar todas actividades

Muestra todas las actividades

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Retornar una actividad

Muestra una actividad

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Actualizar una actividad

Modificar una actividad

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Elimina una actividad

Elimina una actividad

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Muestra escuelas

Muestra la escuela que creo la actividad

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Retornar todos los encargos de una actividad

Retorna información de todos los encargos referentes a una actividad

Responses

Retornar todas las tareas de una actividad

Retorna información de todas las tareas referentes a una actividad

Responses

Retornar todas las notificacion de una actividad

Retorna información de todas las notificacaiones referentes a una active

Responses

Ciclos

Retorna todos los cortes de ciclos

Muestra todas los cortes de ciclos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un cortes de ciclo

Muestra un cortes de ciclo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cycleId
required
integer

Identificador del ciclo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuelas de un ciclo

Muestra la escuela que creo el ciclo

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cycleId
required
integer

Identificador del ciclo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Lenguajes

Retorna todos los idomas

Retorna una lista de lenjuages e idiomas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crear un idioma

Permite crear un nuevo idoma

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra una lenguaje

Retorna la informaicon del lenguaje enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un lenjuage

Modifica los valores de un lenguaje

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminan de lenguajes

Eliminar el lenjuage enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una lista de alumnos

Retorna una lista de alumnos que hablan el idioma enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
languageId
required
integer

Identificador del lenguaje

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Validaciones

Retorna todas las validaciones de calificaciones

Retorna una lista de validaciones de calificaciones

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una validación

Retorna la informaicon de la validación enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una validación

Permite actualizar los datos de una validación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una validación

Elimina una validación

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el parcial de una validación

Retorna el parcial asociado a la validación enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario de una validación

Retorna el usuario que creo la validación enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna las calificaciones de una validación

Retorna un listado de calificaciones validadas por identificador enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
validationId
required
integer

Identificador de la validación

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Caracteristicas

Retorna todas las caracteristicas

Retorna una lista de caracteristicas de alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Crea una caracteristica

Crea un caracteristica

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una caracteristica

Retorna la informaicon de la caracteristica enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una caracteristica

Actualiza los datos de la caracteristica enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una caracteristica

Elimina la caracteristica enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los alumnos de una caracteristica

Retorna una lista de alumnos con la caracteristica enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
characteristicId
required
integer

Identificador de una caracteristica

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Documentos

Retorna todos los documentos

Retorna una lista de documentos del alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un documento

Retorna la informacion del documento enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un documento

Actualizar los datos de un documento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un documento

Actualizar un documento

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna un alumno

Retorna el alumno asociado al documento enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
documentId
required
integer

Identificador de un documento

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Redes sociales

Retorna todas las redes sociales

Retorna una lista de redes sociales del alumnos

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una red social

Retorna la informacion de la red social enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una red social

Actualziar los datos de una red social

path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una red social

Elimina una red social

path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de la red social

Retorna el alumno asociado a la red social enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
socialmediaId
required
integer

Identificador de la red social

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Licencias

Retorna todas las licencias

Retorna una lista de licencias de trabajo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una licencia

Retorna la informacion de la licencia enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una licencia

Actualiza los datos de una licencia

path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina una licencia

Elimina una licencia

path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela de la licencia

Retorna la escuela asociada a la licencia enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario de la licencia

Retorna el usuario asociado a la licencia enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
licenceId
required
integer

Identificador de la licencia

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Rastreos

Retorna todos loas rastros

Retorna una lista de rastros que los alumnos van dejando

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un rastro

Retorna la informacion del rastro enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un rastero

Actualiza los datos de un rastreo

path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un rastreo

Elimina un rastreo

path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el alumno de un rastreo

Retorna el alumno asociado al rastreo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la escuela de un rastreo

Retorna la escuela asociada al rastreo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
traceId
required
integer

Identificador de rastro

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Estados

Retorna todos los estados

Retorna una lista de estados

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un estado

Retorna la informacion del estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un estado

Actualiza los datos de un estado

path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un estado

Elimina un estado

path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el pais de un estado

Retorna el pais al que pertenece el estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Retorna los municipios de un estado

Retorna el listado de municipios que pertenecen al estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Paises

Retorna todos los paises

Retorna una lista de paises

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un pais

Retorna la informacion del pais enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar in pais

Actualizar los datos de un pais

path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar un pais

Actualziar los datos de un pais

path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los estados de un pais

Retorna una lista de estados que pertenecen al pais enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Municipios

Retorna todos las municipios

Retorna una lista de municipios

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un municipio

Retorna la informacion del municipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un municipio

Actualiza los datos del municipio

path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Elimina un municipio

Eliminar un municipio

path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el estado del municipio

Retorna el estado al que pertenece el minicipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas las ciudades de un municipio

Retorna la lista de ciudades que pertenecen al minicipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Ciudades

Retorna todas las ciudades

Retorna una lista de ciudades

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un ciudad

Retorna la informacion de la ciudad enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una ciudad

Actualiza los datos de la clidad

path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eliminar una ciudad

Eliminar una ciudad

path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el municipio de una ciudad

Retorna el municipio al que pertenecen la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los alumnos de una ciudad

Retorna el listado de alumnos que viven la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los usuarios de una ciudad

Retorna el listado de usuarios que viven la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna las escuela de una ciudad

Retorna el listado de escuelas que estan ubicadas la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Incidentes

Retorna todos los incidentes

Muestra todos los incidentes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un incidente

Muestra todos los incidentes

path Parameters
incidents
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un incidente

Actualiza los datos de un incidentes

path Parameters
incidents
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Estadisticas

Retorna todos elementos de Topkey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos elementos de Topkey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna todos elementos de Topkey

Responses

Catalogo de Incidentes

Retorna todo el catalogo de incidentes

Muestra todos los incidentes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un incidente

Muestra todos los incidentes

path Parameters
incidents
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un catalogo de incidente

Actualiza los datos de un catalogo incidentes

path Parameters
incidents
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Exportaciones

Muestra exportables

Muestra exportables

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Supervisor

Buscar escuela por cct

Retorna los datos de la escuela, así como también datos adicionales para realizar un seguimiento de supervisión

query Parameters
clave
required
string

CCT de la escuela

Responses

Response samples

Content type
application/json
{
  • "school": {
    },
  • "total_users": 21,
  • "total_users_trained": 21,
  • "supervisor_user": {
    }
}

Recupera las encuetas

Recupera el listado de preguntas y respuestas que una escuela responderá

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "questions": [
    ],
  • "cataloganswers": [
    ]
}

Procesamiento de la encuesta

Registra las respuestas de las preguntas de una escuela

Request Body schema: application/json
required
school_id
number
Array of objects

Responses

Request samples

Content type
application/json
{
  • "school_id": 1,
  • "survey_answers": [
    ]
}

Response samples

Content type
application/json
Example

La pregunta requiere multiple respuestas

{
  • "message": "La pregunta requiere multiple respuestas",
  • "status": 409,
  • "code": 3401
}

Vista previa de la supervicion de escuelas

Retorna información de todas las escuelas referentes al proceso de supervisión

Responses

Response samples

Content type
application/json
{
  • "school": [
    ],
  • "user": {
    },
  • "total_user": 800,
  • "total_user_trained": 800,
  • "total_user_apk": 800
}

Recupera el detalle de una escuela

Retorna informacion de seguimiento de una escuela en especifico

query Parameters
school_id
required
integer

Identificador de la escuela

Responses

Response samples

Content type
application/json
{
  • "totals": {
    },
  • "users": {
    },
  • "survey_answers": {
    }
}

Encargos

Retorna todas los encargos

Retorna un listado de todos los encargos del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un encargo

Retorna la informacion del encargo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un recurso de encargo

Actualiza los datos de un encargo

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

cancelar encargo

Deshabilita un encargo

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra las tareas de un encargo

retorna el listado de tareas pertenecientes a un encargo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra las actividades de un encargo

retorna el listado de actividades pertenecientes a un encargo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra al profesor de un encargo

retorna al profesor perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra la materia de un encargo

retorna la materia perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra las fuentes de un encargo

retorna la fuentes pertenecientes a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Agrega fuentes a un encargo

Agrega fuentes a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Request Body schema: application/json
required
Array
source_catalog_id
integer
title
string
url_file
string
start
string
last
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra el catalogo de accion de un encargo

retorna el catalogo de accion perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra el formato de entrega de un encargo

retorna el formato de entrega perteneciente a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra las fuentes del catálogo de un encargo

retorna las fuentes del catálogo pertenecientes a un encargo enviado por parametro

path Parameters
assignmentId
required
integer

Identificador del encargo

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Catálogo acciones

Retornar todas las acciones

Retorna información de todas las acciones creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un registro del catálogo de acciones en sistema

Retorna la información de un registro de catálogo de acciones enviado por parametro

path Parameters
catalogActionId
required
integer

Identificador del catalogo de acciones

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los encargos de un catalgo de accion

retorna el listado de encargos pertenecientes a catalogo de accion enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogActionId
required
integer

Identificador del catalogo de acciones

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Tareas

Retornar todas las tareas

Retorna información de todas las tareas creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Actualiza un recurso de tareas

Actualiza información de una tarea referentes a un encargo en sistema

path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra una tarea

Retorna información de una tarea en sistema

path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar el estudiante de una tarea

Retorna información del estudiante referente a una tarea en sistema

path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar todas las notificaciones de una tarea

Retorna información de todas las notificacion referentes a una tarea en sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra el encargo de una tarea

retorna el encargo de una tarea enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
homeworkId
required
integer

Identificador de la tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Notificaciones Tareas

Retornar todas las notificaciones de tareas

Retorna información de todas las notificaciones de tareas creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una notificación de tarea

Retorna información de una notificación de tarea en sistema

path Parameters
homeworkNotificationId
required
integer

Identificador de la notificación de tarea

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catálogo Fuentes

Retornar el catálogo de fuentes

Retorna información de todo el catálogo de fuentes en sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un registro del catálogo de fuentes en sistema

Retorna un registro del catálogo de fuentes en sistema

path Parameters
catalogSourceId
required
integer

Identificador del catalogo de fuentes

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los encargos de un catálogo de fuente

retorna el listado de encargos pertenecientes a un catálogo de fuente enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogSourceId
required
integer

Identificador del catalogo de fuentes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Catálogo Formato de entrega

Retornar el catálogo de formato de entrega

Retorna información de todo el catálogo de formato de entrega en sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un registro del catálogo de formato de entrega en sistema

Retorna un registro del catálogo de formato de entrega en sistema

path Parameters
catalogDeliveryFormatId
required
integer

Identificador del catalogo de formatos de entrega

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra los encargos de un catálogo de formato de entrega

retorna el listado de encargos pertenecientes a un catálogo de formato de entrega enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogDeliveryFormatId
required
integer

Identificador del catalogo de formatos de entrega

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Fuentes

Retornar todas las fuentes

Retorna información de todas las fuentes creadas

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra una fuente

Retorna la informacion de una fuente enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un recurso de fuente

Actualiza información de una fuente en sistema

path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

cancelar fuente

Deshabilita una fuente

path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Muestra el encargo de una fuente

retorna el encargo perteneciente a una fuente enviada por parametro

path Parameters
sourceId
required
integer

Identificador de la fuente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Importaciónes

Retornar todas las Importaciones

Retorna información de todos los recursos de importaciones

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retornar una Importacion

Retorna información de una importacion

path Parameters
imports
required
integer

Identificador de la importacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza una Importacion fallida

Reintenta la actualizacion de una importacion fallida

path Parameters
imports
required
integer

Identificador de la importacion

Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retornar el usuario de una Importacion

Retorna información del usuario que creo una importacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catálogo rastros

Retornar el catálogo de rastros

Retorna el tipo de rastros que puede tener un alumno

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un registro del catálogo de rastros

Retorna la información de un tipo de rastro

path Parameters
catalogtraceId
required
integer

Identificador del catálogo de rastros

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}