Datos adicionales

Obtener configuración de campos

Obtener la configuración de campos para los lugares donde puede ser visible, no visible, editadable, opcional y obligatorio.

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

Obtener categorias

Obtener las categorias existentes para los campos adicionales. Las cuales contienen un listado de los campos que han sido añadidos a esta.

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

Identificador único del profesor

Example: ASWDERF4
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}/fields/categories
Request samples
Response samples
application/json
[
  • {
    }
]

Obtener campos adicionales

Obtener información sobre campos adicionales, incluyendo un listado de campos con sus valores correspondientes y tipos de datos. Dependiendo del tipo de dato, es posible que se proporcione un listado de opciones y valores asociados.

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

Identificador único del profesor

Example: ASWDERF4
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}/fields/data
Request samples
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Actualizar campos adicionales

Este endpoint está diseñado para actualizar información en los campos adicionales de un profesor. La actualización se rige por tipos de datos específicos, lo que significa que la forma en que proporcionas la información depende del tipo de dato del campo que estás actualizando.

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

Identificador único del profesor

Example: ASWDERF4
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
Array (non-empty)
id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del campo adicional

type
required
string

Tipo del valor del campo adicional

value
required
string

Valor del campo adicional

Responses
200

No error

400

Bad parameters

401

Authorization Required

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

Agregar anotación

Agregar anotación a una categoria

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

Identificador único del profesor

Example: ASWDERF4
category_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único de la categoria

Example: GRTHE45D
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
annotation
required
string

Anotación

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/teachers/{teacher_id}/fields/categories/{category_id}/annotations
Request samples
application/json
{
  • "annotation": "Anotación-01"
}
Response samples
application/json
{
  • "details": [ ],
  • "id": "SDWE45GT",
  • "message": "Annotation info added"
}

Eliminar anotación

Eliminar anotación

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

Identificador único del profesor

Example: ASWDERF4
category_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único de la categoria

Example: CVFGRT3E
annotation_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único de la anotación

Example: VGFR453D
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/teachers/{teacher_id}/fields/categories/{category_id}/annotations/{annotation_id}
Request samples
Response samples
application/json
{
  • "details": [ ],
  • "message": "Annotations deleted"
}