<< REST API
Leer estudiantes Leer estudiante Crear estudiante Modificar estudiante Eliminar estudiante
Leer atributos del perfil del estudiante Leer atributo del perfil del estudiante Añadir atributo al perfil del estudiante Asignar valor al atributo del perfil del estudiante Eliminar atributo del perfil del estudiante
Leer pictogramas de la colección del estudiante Leer pictograma de la colección del estudiante Añadir pictograma a la colección del estudiante Asignar propiedad al pictograma de la colección del estudiante Eliminar pictograma de la colección del estudiante
Leer sesiones de trabajo del estudiante Leer matrículas asociadas al estudiante
Leer estudiantes
Operación
GET /student
Petición
No se pasa ningún valor.
Ejemplo de petición:
GET /student
Respuesta
Se devuelve un array de estudiantes.
Ejemplo de respuesta:
[
{
"workingSessions": [],
"stuSups": [],
"profiles": [],
"configurations": [],
"id": 1,
"name": "alumno1",
"surname": "de prueba",
"birthdate": "2001-12-04T23:00:00.000Z",
"notes": null,
"preferedLanguage": "ES"
},
{
...
}
]Leer estudiante
Operación
GET /student/<student-ID>
Petición
Se pasa el ID de estudiante al final de la petición.
Ejemplo de petición:
GET /student/1
Respuesta
Se devuelve el estudiante.
Ejemplo de respuesta:
{
"workingSessions": [],
"enrolments": [],
"stuSups": [],
"profiles": [],
"configurations": [],
"id": 1,
"name": "alumno1",
"surname": "de prueba",
"birthdate": "2001-12-04T23:00:00.000Z",
"notes": null,
"preferedLanguage": "ES"
}Crear estudiante
Operación
POST /student
Petición
Se pasa un objeto JSON con los siguientes campos:
-
name(string): Nombre del estudiante -
surname(string): Apellidos del estudiante -
birthdate(date): Fecha de nacimiento -
notes(string): Observaciones (opcional) -
preferedLanguage(string): Idioma
Ejemplo de petición:
POST /student
{
"name": "John",
"surname": "Doe",
"birthdate": "12/05/2001",
"notes": "Nothing",
"preferedLanguage": "EN"
}Respuesta
Se devuelve un objeto con estudiante creado.
Ejemplo de respuesta:
{
"name": "John",
"surname": "Doe",
"birthdate": "2001-12-04T23:00:00.000Z",
"notes": "Nothing",
"id": 5,
"preferedLanguage": "EN"
}Modificar estudiante
Operación
PUT /student/<student-ID>
Petición
Se pasa el ID de estudinate al final de la petición y un objeto JSON con los campos que se desee modificar:
-
name(string): Nombre del estudiante -
surname(string): Apellidos del estudiante -
birthdate(date): Fecha de nacimiento -
notes(string): Observaciones -
preferedLanguage(string): Idioma
Ejemplo de petición:
PUT /student/5
{
"notes": "Something"
}Respuesta
Se devuelve un objeto con el estudiante modificado.
Ejemplo de respuesta:
{
"workingSessions": [],
"enrolments": [],
"stuSups": [],
"profiles": [],
"configurations": [],
"id": 5,
"name": "John",
"surname": "Doe",
"birthdate": "2001-12-04T23:00:00.000Z",
"notes": "Something",
"preferedLanguage": "EN"
}Eliminar estudiante
Operación
DELETE /student/<student-ID>
Petición
Se pasa el id del estudiante a eliminar al final de la petición.
Ejemplo de petición:
DELETE /student/5
Respuesta
Se devuelve el estudiante eliminado.
Ejemplo de respuesta:
{
"workingSessions": [],
"enrolments": [],
"stuSups": [],
"profiles": [],
"configurations": [],
"id": 5,
"name": "John",
"surname": "Doe",
"birthdate": "2001-12-04T23:00:00.000Z",
"notes": "Something",
"preferedLanguage": "EN"
}Leer atributos del perfil del estudiante
Operación
GET /student/<student-ID>/attributes
Petición
Se pasa el ID de estudiante en la petición.
Ejemplo de petición:
GET /student/2/attributes
Respuesta
Se devuelve un array de objetos JSON con los atributos del perfil del estudiante.
Ejemplo de respuesta:
[
{
"id": 5,
"value": "Paseo de la estación",
"idStu": 2,
"idAtt": 4
},
{
"id": 6,
"value": "Córdoba",
"idStu": 2,
"idAtt": 3
}
]Leer atributo del perfil del estudiante
Operación
GET /student/<student-ID>/attributes/<profile-ID>
Petición
Se pasa el ID del estudiante y el ID del atributo del perfil en la petición.
Ejemplo de petición:
GET /student/2/attributes/6
Respuesta
Se devuelve un objeto JSON con el atributo del perfil del estudiante.
Ejemplo de respuesta:
{
"profile": {
"idStu": 2,
"idAtt": 3,
"id": 6,
"value": "Córdoba"
}
}Añadir atributo al perfil del estudiante
Operación
POST /student/<student-ID>/attributes
Petición
Se pasa el ID del estudiante en la petición y un objeto JSON con los siguientes campos:
-
idAtt(integer): ID del atributo
Ejemplo de petición:
POST /student/2/attributes
{
"idAtt": 3
}Respuesta
Se devuelve un objeto con la entrada del perfil creada.
Ejemplo de respuesta:
{
"profile": {
"value": "",
"id": 6,
"idStu": 2,
"idAtt": 3
}
}Asignar valor al atributo del perfil del estudiante
Operación
PUT /student/<student-ID>/attributes/<profile-ID>
Petición
Se pasa el ID del estudiante y el ID del atributo del perfil en la petición y un objeto JSON con los siguientes campos:
-
value(string): Nuevo valor del atributo
Ejemplo de petición:
PUT /student/2/attributes/6
{
"value": "Córdoba"
}Respuesta
Se devuelve un array con el objeto del atributo con su nuevo valor.
Ejemplo de respuesta:
{
"profile": [
{
"id": 6,
"value": "Córdoba",
"idStu": 2,
"idAtt": 3
}
]
}Eliminar atributo del perfil del estudiante
Operación
DELETE /student/<student-ID>/attributes/<profile-ID>
Petición
Se pasa el ID del estudiante y el ID del atributo del perfil en la petición.
Ejemplo de petición:
DELETE /student/2/attributes/6
Respuesta
Se devuelve un array con el objeto del atributo eliminado.
Ejemplo de respuesta:
{
"profile": [
{
"id": 6,
"value": "Jaén",
"id_stu": 2,
"id_att": 3
}
]
}Leer pictogramas de la colección del estudiante
Operación
GET /student/<student-ID>/pictos
Petición
Se pasa el ID de estudiante en la petición.
Ejemplo de petición:
GET /student/2/pictos
Respuesta
Se devuelve un array de objetos JSON con los pictogramas del estudiante.
Ejemplo de respuesta:
[
{
"id": 1,
"idStu": 2,
"idPic": 1,
"idPp": 1
},
{
"id": 2,
"idStu": 2,
"idPic": 2,
"idPp": 1
}
]Leer pictograma de la colección estudiante
Operación
GET /student/<student-ID>/pictos/<configuration-ID>
Petición
Se pasa el ID del estudiante y el ID del pictograma de la colección del estudiante en la petición.
Ejemplo de petición:
GET /student/2/pictos/1
Respuesta
Se devuelve un objeto JSON con el pictograma de la colección del estudiante.
Ejemplo de respuesta:
{
"configuration": {
"idStu": 2,
"idPic": 1,
"idPp": 1,
"id": 1
}
}Añadir pictograma a la colección del estudiante
Operación
POST /student/<student-ID>/pictos
Petición
Se pasa el ID del estudiante en la petición y un objeto JSON con los siguientes campos:
-
idPic(integer): ID del pictograma
Ejemplo de petición:
POST /student/2/pictos
{
"idPic": 17
}Respuesta
Se devuelve un objeto con el pictograma añadido al usuario.
Ejemplo de respuesta:
{
"configuration": {
"id": 5,
"idStu": 2,
"idPic": 17,
"idPp": 0
}
}Asignar propiedad al pictograma de la colección del estudiante
Operación
PUT /student/<student-ID>/pictos/<configuration-ID>
Petición
Se pasa el ID del estudiante y el ID del pictograma de la colección en la petición y un objeto JSON con los siguientes campos:
-
idPp(integer): ID de la propiedad del pictograma
Ejemplo de petición:
PUT /student/2/pictos/5
{
"idPp": 10
}Respuesta
Se devuelve un array con el objeto del pictograma con la nueva propiedad.
Ejemplo de respuesta:
{
"configuration": [
{
"id": 5,
"idStu": 2,
"idPic": 17,
"idPp": 10
}
]
}Eliminar pictograma de la colección del estudiante
Operación
DELETE /student/<student-ID>/pictos/<configuration-ID>
Petición
Se pasa el ID del estudiante y el ID del pictograma de la colección en la petición.
Ejemplo de petición:
DELETE /student/2/pictos/5
Respuesta
Se devuelve un array con el pictograma eliminado de la colección.
Ejemplo de respuesta:
{
"configuration": [
{
"id": 5,
"id_stu": 2,
"id_pic": 17,
"id_pp": 10
}
]
}Leer sesiones de trabajo del estudiante
Operación
GET /student/<student-ID>/workingSessions
Petición
Se pasa el ID del estudiante en la la petición.
Ejemplo de petición:
GET /student/1/workingSessions
Respuesta
Se devuelve un array de sesiones de trabajo.
Ejemplo de respuesta:
[
{
"id": 1,
"begin": "2014-07-10T22:00:00.000Z",
"end": null,
"description": "sesión 1 de trabajo",
"idStu": 1,
"idSup": 1
},
{
...
}
]Leer matrículas asociadas al estudiante
Operación
GET /student/<student-ID>/enrolments
Petición
Se pasa el ID del estudiante en la la petición.
Ejemplo de petición:
GET /student/1/enrolments
Respuesta
Se devuelve un array de matrículas.
Ejemplo de respuesta:
[
{
"id": 1,
"registration": "2014-01-10T23:00:00.000Z",
"notes": "Matrícula para 3 meses",
"idMet": 1,
"idStu": 1,
"idTea": 1
},
{
...
}
]