<< REST API
Leer instrucciones --> Desde Student se pueden consultar las de cada uno Leer instrucción Nueva instrucción --> Requiere idEnr Modificar objetivo o estado de la instrucción --> UPDATE Finalizar instrucción --> UPDATE Eliminar instrucción
Leer ensayos de una instrucción
Leer instrucciones
Operación
GET /instruction
Petición
No se pasa ningún valor.
Ejemplo de petición:
GET /instruction
Respuesta
Se devuelve un array de instrucciones.
Ejemplo de respuesta:
[
{
"learningUnits": [ ... ],
"idEnr": { ... },
"id": 1,
"objective": "Toma de contacto",
"status": "Finalizada",
"begin": "2014-11-08T23:00:00.000Z",
"end": null
},
{
...
}
]Leer instrucción
Operación
GET /instruction/<instruction-ID>
Petición
Se pasa el ID de la instrucción al final de la petición.
Ejemplo de petición:
GET /instruction/1
Respuesta
Se devuelve la instrucción.
Ejemplo de respuesta:
{
"learningUnits": [ ... ],
"idEnr": { ... },
"id": 1,
"objective": "Toma de contacto",
"status": "Finalizada",
"begin": "2014-11-08T23:00:00.000Z",
"end": null
}Nueva instrucción
Operación
POST /instruction
Petición
Se pasa un objeto JSON con los siguientes campos:
-
idEnr(integer): ID de matrícula del estudiante (enrolment) -
objective(string): Objetivo de la instrucción (opcional) -
begin(datetime): Fecha y hora de inicio
Ejemplo de petición:
POST /instruction
{
"idEnr": 2,
"objective": "Toma de contaco",
"begin": "11/21/2014"
}Respuesta
Se devuelve un objeto con la instrucción creada.
Ejemplo de respuesta:
{
"objective": "Toma de contaco",
"begin": "2014-11-20T23:00:00.000Z",
"id": 5,
"idEnr": 2
}Modificar objetivo o estado de la instrucción
Operación
PUT /instruction/<instruction-ID>
Petición
Se pasa el ID de la instrucción y un objeto JSON con el campo a modificar:
-
objective(string): Descripcion de la sesión de trabajo -
status(string): Estado de la instrucción
Ejemplo de petición:
PUT /instruction/5
{
"status": "En progreso"
}Respuesta
Se devuelve un objeto con el objetivo o estado cambiado.
Ejemplo de respuesta:
{
"learningUnits": [],
"idEnr": { ... },
"id": 5,
"objective": "Toma de contaco",
"status": "En progreso",
"begin": "2014-11-20T23:00:00.000Z",
"end": null
}Finalizar instrucción
Operación
PUT /instruction/<instruction-ID>
Petición
Se pasa el ID de la instrucción y un objeto JSON con el campo a modificar:
-
end(datetime): Fecha y hora de finalización de la instrucción
Ejemplo de petición:
PUT /instruction/5
{
"end": "11/21/2014"
}Respuesta
Se devuelve un objeto con la fecha y hora de finalización fijadas.
Ejemplo de respuesta:
{
"learningUnits": [],
"idEnr": { ... },
"id": 5,
"objective": "Toma de contaco",
"status": "En progreso",
"begin": "2014-11-20T23:00:00.000Z",
"end": "2014-11-20T23:00:00.000Z"
}Eliminar instrucción
Operación
DELETE /instruction/<instruction-ID>
Petición
Se pasa el id de la instrucción a eliminar al final de la petición.
Ejemplo de petición:
DELETE /instruction/5
Respuesta
Se devuelve la instrucción eliminada.
Ejemplo de respuesta:
{
"learningUnits": [],
"idEnr": { ... },
"id": 5,
"objective": "Toma de contaco",
"status": "En progreso",
"begin": "2014-11-20T23:00:00.000Z",
"end": "2014-11-20T23:00:00.000Z"
}Leer ensayos de una instrucción
Operación
GET /instruction/<instruction-ID>/learningUnits
Petición
Se pasa el ID de la instrucción en la la petición.
Ejemplo de petición:
GET /instruction/3/learningUnits
Respuesta
Se devuelve un array de unidades de aprendizaje.
Ejemplo de respuesta:
[
{
"id": 6,
"begin": "2014-11-20T23:00:00.000Z",
"end": "2014-11-20T23:00:00.000Z",
"result": "SUPERVISED SUCCESS",
"description": null,
"idIns": 3,
"idWs": 5
},
{
...
}
]