Algebraix logo
Powered by Redocly

Campus

Obtener campus

Obtener la información del campus en configuración académica

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.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/campus
Request samples 
Response samples 
application/json
[
  • {
    }
]
Agregar campus
Crea un campus con exactamente la misma lógica que la pantalla web Configuración académica → Campus → Agregar.
Un campus cuyo name ya exista (sin distinguir mayúsculas) se rechaza con 400.
coordinates y maximum_timeclock_distance deben enviarse juntos o ninguno de los dos (regla del checador).


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 .. 128 ] characters 
Nombre del campus (único)


 
address
string  <= 256 characters 
Dirección del campus


 
zip_code
string^[0-9]{5}$
Código postal (5 dígitos)


 
description
string
Descripción del campus


 
alternate_id
string  <= 16 characters 
Identificador alterno del campus (la pantalla web solo admite hasta 3 dígitos; la columna admite 16 caracteres)


 
contpaq_code
string  <= 4 characters 
Código de servicio CONTPAQ del campus


 
additional_info
Array of strings  <= 3 items 
Información adicional (hasta 3 textos, se guardan como additional_info_1..3)


 
object
Coordenadas geográficas del campus (para el checador); requiere maximum_timeclock_distance


 
maximum_timeclock_distance
integer  >= 1 
Distancia máxima (metros) permitida para registrar en el checador; requiere coordinates


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/campus
Request samples 
application/json
{
  • "name": "Plantel Norte",
  • "address": "Blvd. Kino 123",
  • "zip_code": "83000",
  • "coordinates": {
    },
  • "maximum_timeclock_distance": 50
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Campus added"
}
➔ Next to Secciones