Especificaciones REST entrantes
Grades Journey v2 puede proporcionar datos de libros de calificaciones usando APIs REST. Aunque estas APIs son diferentes de las APIs principales de Learn, la autenticación de la API Grades Journey v2 sigue el mismo proceso de autenticación OAuth2 que la API principal de Learn REST. Esto requiere una configuración de aplicación API REST en el Anthology Developer Portal.
Sugerencia
Crear un esquema de calificación
Punto final de servicio web
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeSchemasAPI
Ejemplo de cuerpo JSON
[
{
"title": "Pass-Fail-Custom-Schema",
"symbols": "P=80:F=0",
"optionalData": "sisSchemaID=PF"
}
]Definiciones de elementos de esquema de calificación
Nombre del elemento | Descripción | Obligatorio | Tipo y tamaño máximo |
|---|---|---|---|
título | Título del esquema de calificaciones. | Sí | Cuerda (333 caracteres) |
Símbolos | Símbolos en una lista con un límite inferior opcional. | Sí | String (2000 caracteres) |
optionalData | Pares clave/valor con cada conjunto de pares separados por dos puntos, y clave/valores separados por un signo de igual. Por ejemplo: clave1=valor1:clave2=valor2 | no | String (2000 caracteres) |
Respuesta de ejemplo
[
{
"courseId": "",
"name": "Pass-Fail-Custom-Schema",
"status": "OK",
"message": "Grade schema successfully created"
}
]Crear elementos calificables y columnas de calificación
Punto final de servicio web
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradableItemsAPI
Ejemplo de cuerpo JSON
[
{
"courseId": "course1",
"name": "Final Grade",
"itemType": "MANUAL_COLUMN",
"instructions": ""
"anonymous": false,
"group": false,
"contentAreaName": "Assignments",
"available": true,
"attempts": 1,
"tracked": false,
"startDate":
"endDate":
"dueDate": "",
"points": 100,
"gradeSchema": "Pass-Fail-Custom-Schema",
"sequenceNum": 1,
"extract": true,
"mapping": "",
"optionalData": "SIS_ID=FG123456",
}
]Elementos calificables y columnas de calificación Definiciones de elementos
Nombre del elemento | Descripción | Obligatorio | Tipo y tamaño máximo |
|---|---|---|---|
courseId | Batch_uid identificar el curso al que se aplica este ítem calificable o columna de calificación. | Sí | String (256 caracteres) |
nombre | Título del elemento calificable. | Sí | Cuerda (333 caracteres) |
Tipo de ítems | Tipo de elemento calificable para crear. Valores posibles: *ACTIVIDAD, *EXAMEN, ENCUESTA, DISCUSSION_BOARD, WIKI, BLOG, DIARIO, SELF_AND_PEER_TEST, *MANUAL_COLUMN, *WEIGHTED_COLUMN, TOTAL_COLUMN *Campos Ultra y Originales. Todos los demás solo cursos originales. | Sí | Cuerda (333 caracteres) |
instrucciones | Instrucciones para el artículo calificable. | no | String (2000 caracteres) |
anónimo | Si es cierto, la Actividad o Examen se creará con la Calificación Anónima activada. Para cursos ultra, la calificación anónima requiere que se establezca una fecha de entrega en el artículo. | no | Booleano (Falso por defecto) |
grupo | Si es cierto, la actividad se creará como Entrega en Grupo de Tipo de Actividad. | no | Booleano (Falso por defecto) |
contentAreaName | Se creará la ubicación del elemento clasificable. Puede utilizarse en cursos Ultra para aprovisionar una subcarpeta y colocar contenido en la subcarpeta. El valor tiene el formato "parent@>@child", donde "parent" es el nombre de la carpeta superior (parent) y "child" es el nombre de la subcarpeta. Si la subcarpeta ya existe, la actividad se añadirá a la subcarpeta existente. Si la subcarpeta no existe, se creará en la carpeta padre. | no | Cuerda (255 caracteres) |
disponible | Determina si el elemento es visible para los estudiantes. | no | Booleano (Falso por defecto) |
Color | Color del enlace del ítem graduable en un curso original. Nombre del color o valor hexadecimal. Solo cursos originales. | no | Cuerda (10 caracteres) |
Intentos | Número de intentos permitidos para el examen o la actividad. | no | Int (Por defecto –1 para ilimitado) |
Seguimiento | Determina si el seguimiento estadístico está habilitado para el ítem calificable. No se aplica a las columnas de calificación. Solo cursos originales. | no | Booleano (Falso por defecto) |
Fecha de inicio | Mostrar desde la fecha. | no | Fecha |
endDate | Mostrar hasta la fecha. | no | Fecha |
dueDate | Fecha de entrega del ítem calificable. | no | Fecha |
Puntos | Puntos posibles. | no | Float (Por defecto 100.0) |
gradeschema | Nombre del esquema de calificación tal como existe en Learn. Ten en cuenta que este esquema pudo haber sido creado usando el servicio web disponible en Grade Export o en Blackboard Learn. | no | Cuerda (333 caracteres) |
sequenceNum | Secuencia de contenido número de pedido. Solo cursos originales. | no | Int |
extraer | Verdadero/falso – Si es cierto, esta columna se extraerá de la herramienta de extracción. Solo se aplica cuando Grades Journey tiene Provisional habilitada en la página de Configuración de Salida. | no | Cuerda (333 caracteres) |
cartografía | Para una columna ponderada, especifica las correspondencias. El valor predeterminado es no asignar, lo que requiere que el mapeo se realice manualmente directamente en Learn. Estos serán los pares nombre/porcentaje de ítems calificables, separados por una coma, donde los porcentajes suman 100. Ejemplo: Actividad 1=30, Examen 1=30, Examen 2=40. Para una columna de Total, especifica solo las columnas que deben incluirse en el total. Por ejemplo, Actividad 1, Examen 1, Actividad 2, Calificación Final | no | Cuerda (333 caracteres) |
optionalData | Pares clave/valor con cada conjunto de pares separados por dos puntos, y clave/valores separados por un signo de igual. Por ejemplo: clave1=valor1:clave2=valor2 | no | String (2000 caracteres) |
Respuesta de ejemplo
[
{
"status": "OK",
"message": "Gradecolumn successfully created",
"courseId": "course1",
"name": "Final Grade"
}
]Eliminar columnas de calificación
Punto final de servicio web
https://{{hostname}}//learn/api/v2/cc/gradejourney/gradeColumnDeleteAPI
Ejemplo de cuerpo JSON
[
{
"courseId": "course1",
"name": "Final Grade"
}
]Columnas de calificación Eliminar definiciones de elementos
Nombre del elemento | Descripción | Obligatorio | Tipo y tamaño máximo |
|---|---|---|---|
courseId | El curso UID de lote. | Sí | Cuerda (333 caracteres) |
nombre | El nombre de la columna que se elimina. | Sí | Cuerda (333 caracteres) |
Respuesta de ejemplo
[
{
"status": "OK",
"message": "Grade column successfully deleted",
"courseId": "TG-TEST-ORIG",
"name": "Delete Column"
}
]Establecer la calificación externa
(disponible solo para cursos Originales)
Punto final de servicio web
https://{{hostname}}/learn/api/v2/cc/gradejourney/externalGradeColumnAPI
Ejemplo de cuerpo JSON
[
{
"courseId": "course1",
"name": "Final Grade"
}
]Definiciones externas de elementos de columna de calificación
Nombre del elemento | Descripción | Obligatorio | Tipo y tamaño máximo |
|---|---|---|---|
courseId | El curso UID de lote. | Sí | Cuerda (333 caracteres) |
nombre | El nombre de la columna se establecerá como la Calificación Externa. | Sí | Cuerda (333 caracteres) |
Respuesta de ejemplo
[
{
"status": "OK",
"message": "External grade column successfully updated",
"courseId": "course1",
"name": "Final Grade"
}
]Metadatos de creación de inscripción
Punto final de servicio web
https://{{hostname}}/learn/api/v2/cc/gradejourney/userMetadataAPI
Ejemplo de cuerpo JSON
[
{
"courseId": "course1",
"userId": "student1",
"optionalData": "EnrollType=LetterGrade"
},
{
"courseId": "course1",
"userId": "student2",
"optionalData": "EnrollType=Audit"
}
]Definiciones de elementos de metadatos de inscripción
Nombre del elemento | Descripción | Obligatorio | Tipo y tamaño máximo |
|---|---|---|---|
courseId | El curso UID de lote. | Sí | Cuerda (333 caracteres) |
userId | El usuario UID de lote. | Sí | Cuerda (333 caracteres) |
optionalData | Pares clave/valor con cada conjunto de pares separados por dos puntos, y clave/valores separados por un signo de igual. Por ejemplo: clave1=valor1:clave2=valor2 | no | String (2000 caracteres) |
Respuesta de ejemplo
[
{
"status": "OK",
"message": "User metadata successfully created",
"courseId": "course01",
"name": "student01"
},
{
"status": "OK",
"message": "User metadata successfully created",
"courseId": "course02",
"name": "student02"
}
]Valor de Calificación de Actualización
Punto final de servicio web
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeValueAPI
Ejemplo de cuerpo JSON
[
{
"courseId": "course001",
"userId": "user1",
"name": "FINAL GRADE",
"value": "B"
}
] Definiciones de Elementos de Actualización de Valor de Calificación
Nombre del elemento | Descripción | Obligatorio | Tipo y tamaño máximo |
|---|---|---|---|
courseId | El curso UID de lote. | Sí | Cuerda (333 caracteres) |
userId | El usuario UID de lote. | Sí | Cuerda (333 caracteres) |
nombre | La columna cuyo valor debe actualizarse. | Sí | Cuerda (333 caracteres) |
valor | El valor de la calificación a actualizar. | Sí | Cuerda (333 caracteres) |
Respuesta de ejemplo
[
{
"status": "OK",
"message": "Grade value successfully added",
"courseId": "course1",
"name": "Final Grade"
}
]