Saltar al contenido principal

Grados

Emisión de información de Grados​

Esta integración permitirá que la información de los grados sea compartida entre ambos sistemas, asegurando que los datos estén siempre actualizados y sincronizados.

Generalidades/Requerimientos​

  • El proceso de emisión al sistema externo debe ser por medio de un endpoint que el sistema externo proporcione a Idukay.
  • La información emitida al sistema externo está en formato JSON.
  • Si el sistema externo no recibe la información o se presenta algún error, se notificará al sistema externo para que tome las acciones necesarias e intente nuevamente la emisión de la información.
  • Es importante seguir el estándar de emisión de información: en el momento de la creación, debe utilizarse un POST y para la actualización, un PUT.

Evento de crear grado​

warning

Es importante que la información devuelta por el sistema externo incluya el id generado para el grado creado. Este id es necesario para poder actualizar la información del grado.

Cada vez que se crea un grado en Idukay, se envía la información del grado creado al endpoint del sistema externo. El sistema externo debe estar preparado para recibir el evento de creación de grado y así obtener la información correspondiente.

Estructura datos grados▼
Ejemplo de emisión de información de grado
curl --method POST \
  --url https://example.com/api/integration/grades \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "1A",
    "name": "Primero de básica",
    "section": "647582d00000000000000000",
    "metadata": {
      "school": "647582d00000000000000000",
      "grade": "60b31bd00000000000000000"
    }
  }'
Respuesta sistema externo
{
  "status": "success",
  "data": {
    "id": "60b31bd00000000000000000"
  }
}

Evento de actualizar grado​

warning

Es importante que el sistema externo garantice un update atómico de la información del grado. Es decir, Idukay enviará la información del grado con los campos que han sido actualizados, por lo que el sistema externo debe actualizar solo esos campos y no sobreescribir toda la información del grado.

Esto es crucial para evitar que la información del grado quede desactualizada.

Cada vez que se actualiza un grado en Idukay, se envía la información del grado actualizado al endpoint del sistema externo. El sistema externo debe estar preparado para recibir el evento de actualización de grado y así obtener la información correspondiente.

Estructura datos grado▼
Ejemplo de emisión de información del grado
curl --method PUT \
  --url https://example.com/api/integration/grades/:gradeId \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "1A - 2",
    "name": "Primero de básica",
    "section": "647582d00000000000000000",
    "metadata": {
      "school": "647582d00000000000000000",
      "grade": "60b31bd00000000000000000"
    }
  }'
Respuesta sistema externo
{
  "status": "success",
  "data": {
    "userId": "60b31bd00000000000000000"
  }
}