General

Obtener padres de familia

Obtener información de los padres de familia de los estudiantes

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

Límite padres de familia

page
integer >= 1
Default: 1

Número de página para consulta

is_active
boolean

Obtener padres activos o inactivos (true o false)

has_relations
boolean

Obtener padres con o sin relaciones (true o false)

username
string

Obtener padres por nombre de usuario

lastname
string

Obtener padres por apellido

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

Agregar padre de familia

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 padre de familia

lastname1
required
string [ 1 .. 64 ] characters

Primer apellido

lastname2
string

Segundo apellido

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

Asigna una contraseña al padre de familia

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

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

Nombre del usuario

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 padre de familia

object

Cuenta de google

sex
required
string (sex)

Sexo del padre de familia

Enum: "MALE" "FEMALE"
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

mobile_telephone
string

Número de teléfono celular

work_telephone
string

Número de teléfono del trabajo del padre de familia

occupation
string

Ocupación del padre de familia

company
string

Compañia del padre de familia

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/parents
Request samples
application/json
{
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "address_line_1": "Cerrada Norte Pelayo 897 Interior 060",
  • "city": "hermosillo",
  • "state": "SONORA",
  • "zipcode": 70260,
  • "telephone": "6622436745",
  • "mobile_telephone": "6622436745",
  • "work_telephone": "6622436685",
  • "occupation": "gerente",
  • "company": "general motors"
}
Response samples
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Parent added"
}

Obtener padres de familia por ID

Obtener información de los padres de familia de los estudiantes

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

Identificador único del padre de familia

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

Actualizar padre de familia

Actualizar informacion personal del padre de familia

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

Identificador único del padre de familia

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 padre de familia

lastname1
string

Primer apellido

lastname2
string

Segundo apellido

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

Asigna una contraseña al padre de familia

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

Nombre del usuario

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

Correo electrónico del padre de familia

object

Cuenta de google

sex
string (sex)

Sexo del padre de familia

Enum: "MALE" "FEMALE"
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

mobile_telephone
string

Número de teléfono celular

work_telephone
string

Número de teléfono del trabajo del padre de familia

occupation
string

Ocupación del padre de familia

company
string

Compañia del padre de familia

Responses
200

No error

400

Bad parameters

401

Authorization Required

patch/parents/{parent_id}
Request samples
application/json
{
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "address_line_1": "Cerrada Norte Pelayo 897 Interior 060",
  • "city": "hermosillo",
  • "state": "SONORA",
  • "zipcode": 70260,
  • "telephone": "6622436745",
  • "mobile_telephone": "6622436745",
  • "work_telephone": "6622436685",
  • "occupation": "gerente",
  • "company": "general motors"
}
Response samples
application/json
{
  • "details": [ ],
  • "message": "Parent data updated"
}

Desactivar padre de familia

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

Identificador único del padre de familia

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/parents/{parent_id}/deactivate
Request samples
Response samples
application/json
{
  • "details": [ ],
  • "message": "Parent deactivated"
}