Algebraix logo
Powered by Redocly

General

Obtener solicitantes

Obtener información general de los solicitantes

Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Límite de solicitantes

page
integer >= 1
Default: 1

Número de página de consulta

username
string

Obtener solicitantes por nombre de usuario

lastname
string

Obtener solicitantes por apellido

student_number
string

Obtener solicitantes por matricula

curp
string

Obtener solicitantes por CURP

email
string

Obtener solicitantes por email

start_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha inicial para búsqueda por fecha de modificación

Nota importante: Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas

end_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha final para búsqueda por fecha de modificación

Nota importante: Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/solicitors
Request samples 
Response samples 
application/json
[
  • {
    }
]
Agregar solicitante
Request 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
cycle_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del ciclo


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


 
section_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único de la sección


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


 
level_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del grado


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


 
name
required
string  [ 1 .. 64 ] characters 
Nombre del solicitante


 
lastname1
required
string  [ 1 .. 64 ] characters 
Apellido paterno


 
lastname2
string  <= 64 characters 
Apellido Materno


 
password
string (password)   [ 8 .. 64 ] characters ^(?=.*[A-Z])(?=.*\d)[A-Za-z\d\W_]{8,64}$
Asigna una contraseña al solicitante


Si el campo no se incluye, el sistema lo generará automáticamente.


 
username
string (username)   [ 4 .. 32 ] characters ^\w*$
 Default:  "SOLICITOR"
Nombre del usuario


Nota: En caso de que deseen agregar un nombre de usuario personalizado, es necesario habilitar la propiedad allow_plataform_access


 
student_number
integer  >= 1 
Matrícula del solicitante


Si el campo no se incluye, el sistema lo generará automáticamente.


 
curp
string (curp) ^$|^[A-Z][AEIOUX][A-Z]{2}[0-9]{2}[0-1][0-9][0...
CURP del solicitante


 
email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
Correo electrónico del solicitante


 
object
Cuenta de google


 
sex
required
string (sex) 
Sexo del solicitante


 Enum: "MALE" "FEMALE"  
has_own_supervision
boolean
Indica si tiene supervisión propia el solicitante


 
is_enable_tuition
boolean
Cobro automático de colegiatura por cada periodo


Para permitir el procesamiento de cobros recurrentes deberá enviarse en 'true'   


 
is_disable_automatic_suspensions
boolean
Inhabilitar suspensiones automáticas


 
is_disable_latefees
boolean
Inhabilitar cargos


 
is_disable_discounts
boolean
Inhabilitar descuentos


 
allow_social_networking
boolean
Permitir acceso a redes sociales del campus


 
allow_plataform_access
boolean
Tiene acceso a la plataforma


Nota: En caso de que no se habilite esta opción, el usuario será 'SOLICITOR', de lo contrario se guardará el usuario personalizado o se autogenerará uno


 
has_syt_own_supervision
boolean
Supervisión propia en salidas y transportes


 
Array of objects  <= 4 items 
Cargos por inscripción


 
address_line_1
string  [ 1 .. 254 ] characters 
Dirección 1


 
address_line_2
string  <= 254 characters 
Dirección 2


 
city
string  [ 1 .. 254 ] characters 
Ciudad


 
state
string (state)   <= 64 characters 
Estado


 Enum: "AGUASCALIENTES" "BAJA CALIFORNIA" "BAJA CALIFORNIA SUR" "CAMPECHE" "CIUDAD DE MEXICO" "CHIAPAS" "CHIHUAHUA" "COAHUILA" "COLIMA" "DURANGO" "GUANAJUATO" "GUERRERO" "HIDALGO" "JALISCO" "MEXICO" "MICHOACAN" "MORELOS" "NAYARIT" "NUEVO LEON" "OAXACA" "PUEBLA" "QUERETARO" "QUINTANA ROO" "SAN LUIS POTOSI" "SINALOA" "SONORA" "TABASCO" "TAMAULIPAS" "TLAXCALA" "VERACRUZ" "YUCATAN" "ZACATECAS"  
zipcode
integer  [ 1 .. 16 ] characters 
Código postal


 
telephone
string
Número de teléfono


 
emergency_telephone
string
Número de teléfono en caso de emergencia


 
birthday
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Fecha de nacimiento


 
blood_type
string (blood_type) 
Tipo de sangre del solicitante


 Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"  
allergies
string
Alergias del solicitante


 
additional_information
string
Información adicional


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/solicitors
Request samples 
application/json
{
  • "cycle_id": "YVOD2QEF",
  • "section_id": "YVOD2QEF",
  • "level_id": "YVOD2QEF",
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "student_number": 123456,
  • "curp": "GOVM860812MJCNLR05",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "has_own_supervision": true,
  • "allow_plataform_access": false,
  • "address_line_1": "Cerrada Norte Pelayo 897 Interior 060",
  • "city": "hermosillo",
  • "state": "SONORA",
  • "zipcode": 83280,
  • "telephone": "6622436745",
  • "birthday": "02/07/1994",
  • "blood_type": "O+"
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Student added under registration number"
}
Obtener solicitantes por ID
Obtener información personal del solicitante


Request 
path Parameters
solicitor_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del solicitante


 
 Example:  WADFERF3
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/solicitors/{solicitor_id}
Request samples 
Response samples 
application/json
{
  • "id": "ADFEGT56",
  • "username": "JLUIS01",
  • "student_number": 100473,
  • "name": "JOSE LUIS",
  • "lastname": "RUIZ SOTO",
  • "lastname1": "RUIZ",
  • "lastname2": "SOTO",
  • "group": {
    },
  • "level": {
    },
  • "curp": "RUSJA860313MSRCNL09",
  • "has_picture": true,
  • "has_profile_picture": false,
  • "has_plataform_access": true,
  • "is_internet_applicant": true,
  • "email": "jluis@gmail.com",
  • "google_account": {
    },
  • "use_authenticator": false,
  • "birthday": "10/07/2000",
  • "age": "23",
  • "sex": "MALE",
  • "address_line_1": "camino a san pablo 34",
  • "address_line_2": "",
  • "city": "xochimilco",
  • "state": "ciudad de mexico",
  • "zipcode": "16200",
  • "telephone": "5565216431",
  • "emergency_telephone": "5555233974",
  • "additional_information": "",
  • "has_own_supervision": true,
  • "has_disable_online_payments": false,
  • "has_enable_tuition": false,
  • "has_disable_automatic_suspensions": false,
  • "has_disable_latefees": false,
  • "has_disable_discounts": false,
  • "has_syt_own_supervision": false,
  • "blood_type": "O+",
  • "allergies": "ninguna",
  • "language_preference": "ES"
}
Actualizar solicitante
Actualizar datos personales del solicitante


Request 
path Parameters
solicitor_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del solicitante


 
 Example:  WADFERF3
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
cycle_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del ciclo


 
section_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único de la sección


 
level_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del grado


 
name
string  [ 1 .. 64 ] characters 
Nombre del solicitante


 
lastname1
string  [ 1 .. 64 ] characters 
Apellido paterno


 
lastname2
string  <= 64 characters 
Apellido Materno


 
password
string (password)   [ 8 .. 64 ] characters ^(?=.*[A-Z])(?=.*\d)[A-Za-z\d\W_]{8,64}$
Asigna una contraseña al solicitante


 
username
string (username)   [ 4 .. 32 ] characters ^\w*$
Nombre del usuario


 
student_number
integer  >= 1 
Matrícula del estudiante


 
curp
string (curp) ^$|^[A-Z][AEIOUX][A-Z]{2}[0-9]{2}[0-1][0-9][0...
CURP del solicitante


 
email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
Correo electrónico del solicitante


 
object
Cuenta de google


 
sex
string (sex) 
Sexo del solicitante


 Enum: "MALE" "FEMALE"  
has_own_supervision
boolean
Si tiene supervisión propia el solicitante


 
is_disable_online_payments
boolean
Inhabilitar pagos en línea


 
allow_plataform_access
boolean
Habilitar acceso para la plataforma


 
has_syt_own_supervision
boolean
Supervisión propia en salidas y transportes


 
address_line_1
string  <= 254 characters 
Dirección 1


 
address_line_2
string  <= 254 characters 
Dirección 2


 
city
string  <= 254 characters 
Ciudad


 
state
string (state)   <= 64 characters 
Estado


 Enum: "AGUASCALIENTES" "BAJA CALIFORNIA" "BAJA CALIFORNIA SUR" "CAMPECHE" "CIUDAD DE MEXICO" "CHIAPAS" "CHIHUAHUA" "COAHUILA" "COLIMA" "DURANGO" "GUANAJUATO" "GUERRERO" "HIDALGO" "JALISCO" "MEXICO" "MICHOACAN" "MORELOS" "NAYARIT" "NUEVO LEON" "OAXACA" "PUEBLA" "QUERETARO" "QUINTANA ROO" "SAN LUIS POTOSI" "SINALOA" "SONORA" "TABASCO" "TAMAULIPAS" "TLAXCALA" "VERACRUZ" "YUCATAN" "ZACATECAS"  
zipcode
integer  [ 1 .. 16 ] characters 
Código postal


 
telephone
string
Número de teléfono


 
emergency_telephone
string
Número de teléfono en caso de emergencia


 
birthday
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Fecha de nacimiento


 
blood_type
string (blood_type) 
Tipo de sangre del solicitante


 Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"  
allergies
string
Alergias del solicitante


 
additional_information
string
Información adicional


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/solicitors/{solicitor_id}
Request samples 
application/json
{
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "student_number": 123456,
  • "curp": "GOVM860812MJCNLR05",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "allow_plataform_access": false,
  • "has_own_supervision": true,
  • "address_line_1": "Cerrada Norte Pelayo 897 Interior 060",
  • "city": "hermosillo",
  • "state": "SONORA",
  • "zipcode": 83280,
  • "telephone": "6622436745",
  • "birthday": "02/07/1994",
  • "blood_type": "O+",
  • "cycle_id": "YVOD2QEF",
  • "section_id": "YVOD2QEF",
  • "level_id": "YVOD2QEF"
}
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Updated solicitor data"
}
Eliminar solicitante
¡Este proceso es irreversible!


Este proceso irreversible causará la eliminación de horarios, calificaciones, relaciones con padres de familia, asistencia, etc.


Debe tener en cuenta que:


    

  1. Se eliminarán TODOS los datos del solicitante. Calificaciones, facturas, pagos, recibos, etc.
    2. 

  2. Este proceso es irreversible
    3. 

  3. En caso de requerir la restauración de esta información, se requiere de la ayuda personalizada del equipo técnico de Algebraix lo cual tendrá un costo adicional.
    4. 



Request 
path Parameters
solicitor_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del solicitante


 
 Example:  WADFERF3
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


delete/solicitors/{solicitor_id}
Request samples 
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Solicitor eliminated"
}
Activar solicitante
Pasar solicitante a estudiante activo


Request 
path Parameters
solicitor_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del solicitante


 
 Example:  WADFERF3
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
group_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del grupo


 
has_suscribe_group
boolean
Habilita la opción "Inscribir en clases del grupo"


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/solicitors/{solicitor_id}/activate
Request samples 
application/json
{
  • "group_id": "stringst",
  • "has_suscribe_group": true
}
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Student have been enrolled"
}
Obtener fotografía de control escolar
Obtener información de la fotografía de control escolar


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  DFER45EW
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/students/{student_id}/pictures
Request samples 
Response samples 
application/json
{}
Obtener fotografía de perfil
Obtener información de la fotografía de perfil


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  DFER45EW
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/students/{student_id}/pictures/profile
Request samples 
Response samples 
application/json
{}
➔ Next to Datos adicionales