General

Obtener profesores

Obtener información personal acerca de los profesores del campus.

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

Límite de profesores

page
integer >= 1
Default: 1

Número de página de consulta

is_active
boolean

Obtener profesores activos o inactivos (true o false)

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/teachers
Request samples
Response samples
application/json
[
  • {
    }
]

Agregar profesor

Agregar profesor con la configuración que el campus le proporcione.

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
name
required
string [ 1 .. 64 ] characters

Nombre del profesor

lastname1
required
string [ 1 .. 64 ] characters

Apellido paterno

lastname2
string

Apellido Materno

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

Nombre del usuario

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

password
string (password) [ 8 .. 64 ] characters ^(?=.*[A-Z])(?=.*\d)[A-Za-z\d\W_]{8,64}$

Asigna una contraseña al profesor.

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

email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...

Correo electrónico del profesor

object

Cuenta de google

title
string

Título del profesor

sex
required
string (sex)

Sexo del profesor

Enum: "MALE" "FEMALE"
message_bcc_user_id
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador del usuario al que se quiera copiar en los mensajes

can_add_reports
boolean

Permiso para crear reportes / Seguimientos de reportes

can_view_annotations
boolean

Permiso para ver anotaciones

can_add_annotations
boolean

Permiso para crear anotaciones

has_syt_exit_permission
boolean

Habilita permiso para entrega de estudiantes (salidas y transportes)

use_timeclock
boolean

Habilita la opción para uso de checador

timeclock_phone_number
string

Celular para uso del checador

can_block_shadow
boolean

Bloquear ver sesión de usuario

address_line_1
string

Primera parte de la dirección

address_line_2
string

Segunda parte de la dirección

city
string

Ciudad

state
string (state)

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

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 profesor

Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"
allergies
string

Alergias del profesor

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/teachers
Request samples
application/json
{
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "message_bcc_user_id": "BBBBBBB8",
  • "can_add_reports": true,
  • "can_block_shadow": 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": "Teacher added"
}

Obtener profesor por ID

Obtener información personal del profesor.

Request
path Parameters
teacher_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del profesor

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/teachers/{teacher_id}
Request samples
Response samples
application/json
{
  • "id": "WADFERF3",
  • "is_active": true,
  • "is_tutor": false,
  • "username": "PROFESOR01",
  • "title": "ING. SISTEMAS",
  • "name": "JOSE LUIS",
  • "lastname": "RUIZ SOTO",
  • "lastname1": "RUIZ",
  • "lastname2": "SOTO",
  • "has_picture": false,
  • "has_profile_picture": false,
  • "email": "profesor01@gmail.com",
  • "google_account": {
    },
  • "use_authenticator": false,
  • "birthday": "10/07/1990",
  • "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",
  • "blood_type": "O+",
  • "allergies": "",
  • "language_preference": "EN",
  • "message_bcc_user": { },
  • "can_add_reports": false,
  • "can_add_annotations": false,
  • "can_view_annotations": false,
  • "has_syt_exit_permission": false,
  • "can_block_shadow": false,
  • "timeclock": {
    }
}

Actualizar profesor

Actualizar información personal del profesor, es posible actualizar 1 o múltiples datos del profesor.

Request
path Parameters
teacher_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del profesor

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
name
string

Nombre del profesor

lastname1
string

Apellido paterno

lastname2
string

Apellido Materno

password
string (password) [ 8 .. 64 ] characters ^(?=.*[A-Z])(?=.*\d)[A-Za-z\d\W_]{8,64}$

Contraseña del profesor

email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...

Correo electrónico del profesor

object

Cuenta de google

title
string

Título del profesor

sex
string (sex)

Sexo del profesor

Enum: "MALE" "FEMALE"
message_bcc_user_id
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador del usuario al que se quiere copiar los mensajes

can_add_reports
boolean

Permiso para crear reportes / Seguimientos de reportes

can_view_annotations
boolean

Permiso para ver anotaciones

can_add_annotations
boolean

Permiso para crear anotaciones

has_syt_exit_permission
boolean

Permiso para entrega de estudiantes

use_timeclock
boolean

Permiso para uso del checador

timeclock_phone_number
string

Celular para uso del checador

can_block_shadow
boolean

Indica si está activa la opción Bloquear ver sesión del usuario

address_line_1
string

Primera parte de la dirección

address_line_2
string

Segunda parte de la dirección

city
string

Ciudad

state
string (state)

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

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 profesor

Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"
allergies
string

Alergias del profesor

Responses
200

No error

400

Bad parameters

401

Authorization Required

patch/teachers/{teacher_id}
Request samples
application/json
{
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido2",
  • "password": "P@ssword-23",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "message_bcc_user_id": "BBBBBBB8",
  • "can_add_reports": true,
  • "can_block_shadow": false,
  • "address_line_1": "Cerrada Rosa de los Vientos 30",
  • "city": "Hermosillo",
  • "state": "SONORA",
  • "zipcode": 81111,
  • "telephone": "2603423745",
  • "birthday": "02/07/1994",
  • "blood_type": "O+"
}
Response samples
application/json
{
  • "details": [ ],
  • "message": "Teacher data updated"
}

Desactivar profesor

Request
path Parameters
teacher_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del profesor

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

patch/teachers/{teacher_id}/deactivate
Request samples
Response samples
application/json
{
  • "details": [ ],
  • "message": "Teacher deactivated"
}