<< REST API
Leer supervisores --> ¿Meter info de Tutor/Teacher o meter en Tutor/Teacher? Leer supervisor --> ¿Meter info de Tutor/Teacher o meter en Tutor/Teacher? Crear supervisor --> En Tutor/Teacher Modificar supervisor Eliminar supervisor --> CONFIRMAR
Leer pictogramas del supervisor --> Ver si la información es suficiente o afinar más mostrando info de Picto Leer pictograma del supervisor --> Idem arriba Conceder permiso sobre un pictograma al supervisor Revocar permiso sobre un pictograma al supervisor
Leer pictogramas propios --> CONFIRMAR
Leer etiquetas propias de un pictograma Leer etiqueta propia de un pictograma Asignar etiqueta propia a un pictograma Eliminar etiqueta propia de un pictograma
Leer alumnos del supervisor Leer alumno del supervisor Vincular alumno Desvincular alumno
Leer sesiones de trabajo del supervisor Leer acciones del supervisor
Leer supervisores
Operación
GET /supervisor
Petición
No se pasa ningún valor.
Ejemplo de petición:
GET /supervisor
Respuesta
Se devuelve un array de supervisores.
Ejemplo de respuesta:
[
{
"workingSessions": [ ... ],
"ownPictos": [ ... ],
"pictos": [ ... ],
"students": [ ... ],
"actions": [ ... ],
"id": 1,
"name": "Arturo",
"surname": "Montejo",
"postalAddress": null,
"contactEmail": "amontejo@ujaen.es",
"contactPhone": null,
"preferedLanguage": "ES"
},
{
...
}
]Leer supervisor
Operación
GET /supervisor/<supervisor-ID>
Petición
Se pasa el ID del supervisor al final de la petición.
Ejemplo de petición:
GET /supervisor/1
Respuesta
Se devuelve el supervisor.
Ejemplo de respuesta:
{
"workingSessions": [ ... ],
"ownPictos": [ ... ],
"pictos": [ ... ],
"students": [ ... ],
"actions": [ ... ],
"id": 1,
"name": "Arturo",
"surname": "Montejo",
"postalAddress": null,
"contactEmail": "amontejo@ujaen.es",
"contactPhone": null,
"preferedLanguage": "ES"
}Modificar supervisor
Operación
PUT /supervisor/<supervisor-ID>
Petición
Se pasa el ID de supervisor al final de la petición y un objeto JSON con los campos que se desee modificar:
-
name(string): Nombre del supervisor -
surname(string): Apellidos del supervisor -
contactEmail(string): Email del supervisor -
postalAddress(string): Dirección del supervisor (opcional) -
contactPhone(string): Teléfono del supervisor (opcional) -
preferedLanguage(string): Idioma preferido (Ejemplo: ES)
Ejemplo de petición:
PUT /supervisor/1
{
"contactPhone": "+34 953 24 22 23"
}Respuesta
Se devuelve un objeto con el supervisor modificado.
Ejemplo de respuesta:
{
"workingSessions": [ ... ],
"ownPictos": [ ... ],
"pictos": [ ... ],
"students": [ ... ],
"actions": [ ... ],
"id": 1,
"name": "Arturo",
"surname": "Montejo",
"postalAddress": null,
"contactEmail": "amontejo@ujaen.es",
"contactPhone": "+34 953 24 22 23",
"preferedLanguage": "ES"
}Leer pictogramas del supervisor
Operación
GET /supervisor/<supervisor-ID>/pictos
Petición
Se pasa el ID del supervisor en la petición.
Ejemplo de petición:
GET /supervisor/1/pictos
Respuesta
Se devuelve un array de objetos JSON con los pictogramas que puede ver el supervisor.
Ejemplo de respuesta:
[
{
"id": 1,
"privilege": "F",
"timestamp": null,
"idSup": 1,
"idPic": 1
},
{
...
}
]Leer pictograma del supervisor
Operación
GET /supervisor/<supervisor-ID>/pictos/<acl-picto-ID>
Petición
Se pasa el ID del supervisor y el ID del pictograma en la petición.
Ejemplo de petición:
GET /supervisor/1/pictos/2
Respuesta
Se devuelve un objeto JSON con el pictograma.
Ejemplo de respuesta:
{
"tags": [],
"idSup": { ... },
"idPic": { ... },
"id": 2,
"privilege": "F",
"timestamp": null
}Conceder permiso sobre un pictograma
Operación
POST /supervisor/<supervisor-ID>/pictos
Petición
Se pasa el ID del supervisor en la petición y un objeto JSON con los siguientes campos:
-
idPic(integer): ID del pictograma a asignar al supervisor -
privilege(string): Tipo de permiso concedido -
timestamp(datetime): Fecha en la que se concede el permiso (opcional)
Ejemplo de petición:
POST /supervisor/1/pictos
{
"idPic": 2,
"privilege": "F"
}Respuesta
Se devuelve un objeto con el permiso sobre el pictograma creado.
Ejemplo de respuesta:
{
"privilege": "F",
"id": 3,
"idSup": 1,
"idPic": 2
}Revocar permiso sobre un pictograma
Operación
DELETE /supervisor/<supervisor-ID>/pictos/<acl-picto-ID>
Petición
Se pasa el ID del supervisor y el ID del permiso sobre el pictograma a revocar.
Ejemplo de petición:
DELETE /supervisor/1/pictos/2
Respuesta
Se devuelve un objeto con el permiso sobre el pictograma eliminado.
Ejemplo de respuesta:
{
"tags": [],
"idSup": { ... },
"idPic": { ... },
"id": 2,
"privilege": "F",
"timestamp": null
}Leer pictogramas propios
Operación
GET /supervisor/<supervisor-ID>/ownPictos
Petición
Se pasa el ID del supervisor en la petición.
Ejemplo de petición:
GET /supervisor/2/ownPictos
Respuesta
Se devuelve un array de objetos JSON con los pictogramas.
Ejemplo de respuesta:
[
{
"id": 1,
"uri": "/pictos/food/apple.png",
"idPic": null,
"idSou": 1,
"idOwner": 2
},
{
...
}
]Leer etiquetas propias de un pictograma
Operación
GET /supervisor/<supervisor-ID>/pictos/<acl-picto-ID>/tags
Petición
Se pasa el ID del supervisor e ID del permiso sobre el pictograma en la petición.
Ejemplo de petición:
GET /supervisor/1/pictos/2/tags
Respuesta
Se devuelve un array de objetos JSON con las etiquetas del pictograma.
Ejemplo de respuesta:
{
"tags": [
{
"idAclPicto": 2,
"idTag": 1,
"id": 1
},
{
...
}
]
}Leer etiqueta propia de un pictograma
Operación
GET /supervisor/<supervisor-ID>/pictos/<acl-picto-ID>/tags/<sup-picto-tag-ID>
Petición
Se pasa el ID del supervisor, el ID del permiso sobre el pictograma y el ID de la etiqueta propia.
Ejemplo de petición:
GET /supervisor/1/pictos/2/tags/1
Respuesta
Se devuelve un objeto JSON con la etiqueta propia.
Ejemplo de respuesta:
{
"idAclPicto": {
"id": 2,
"privilege": "F",
"timestamp": null,
"idSup": 1,
"idPic": 5
},
"idTag": {
"id": 1,
"label": "food"
},
"id": 1
}Asignar etiqueta propia a un pictograma
Operación
POST /supervisor/<supervisor-ID>/pictos/<acl-picto-ID>/tags
Petición
Se pasa el ID del supervisor, el ID del permiso sobre el pictograma en la petición y un objeto JSON con los siguientes campos:
-
idTag(integer): ID de la etiqueta a asignar al pictograma
Ejemplo de petición:
POST /supervisor/1/pictos/2/tags
{
"idTag": 3
}Respuesta
Se devuelve un objeto con el la etiqueta asignada.
Ejemplo de respuesta:
{
"id": 1,
"idAclPicto": 2,
"idTag": 3
}Eliminar etiqueta propia de un pictograma
Operación
DELETE /supervisor/<supervisor-ID>/pictos/<acl-picto-ID>/tags/<sup-picto-tag-ID>
Petición
Se pasa el ID del supervisor, el ID del permiso sobre el pictograma y el ID de la etiqueta a eliminar.
Ejemplo de petición:
DELETE /supervisor/1/pictos/2/tags/1
Respuesta
Se devuelve un objeto con la etiqueta eliminada.
Ejemplo de respuesta:
{
"idAclPicto": {
"id": 2,
"privilege": "F",
"timestamp": null,
"idSup": 1,
"idPic": 5
},
"idTag": {
"id": 1,
"label": "food"
},
"id": 1
}Leer alumnos del supervisor
Operación
GET /supervisor/<supervisor-ID>/students
Petición
Se pasa el ID del supervisor en la petición.
Ejemplo de petición:
GET /supervisor/1/students
Respuesta
Se devuelve un array de objetos JSON con los alumnos del supervisor.
Ejemplo de respuesta:
[
{
"id": 1,
"role": "T",
"idStu": 1,
"idSup": 1
},
{
...
}
]Leer alumno del supervisor
Operación
GET /supervisor/<supervisor-ID>/students/<stu-sup-ID>
Petición
Se pasa el ID del supervisor y el ID del alumno en la petición.
Ejemplo de petición:
GET /supervisor/1/students/3
Respuesta
Se devuelve un objeto JSON con el alumno.
Ejemplo de respuesta:
{
"idStu": {
"id": 2,
"name": "alumno2",
"surname": "de prueba",
"birthdate": "2000-02-04T23:00:00.000Z",
"notes": null,
"preferedLanguage": "ES"
},
"idSup": {
"id": 1,
"name": "Arturo",
"surname": "Montejo",
"postalAddress": null,
"contactEmail": "amontejo@ujaen.es",
"contactPhone": null,
"preferedLanguage": "ES"
},
"id": 3,
"role": "T"
}Vincular alumno al supervisor
Operación
POST /supervisor/<supervisor-ID>/students
Petición
Se pasa el ID del supervisor en la petición y un objeto JSON con los siguientes campos:
-
idStu(integer): ID del estudiante a vincular al supervisor -
role(string): Relación entre el supervisor y el estudinate
Ejemplo de petición:
POST /supervisor/1/students
{
"idStu": 1,
"role": "T"
}Respuesta
Se devuelve un objeto con los datos de la vinculación creada.
Ejemplo de respuesta:
{
"role": "T",
"id": 1,
"idStu": 1,
"idSup": 1
}Desvincular alumno de un supervisor
Operación
DELETE /supervisor/<supervisor-ID>/students/<stu-sup-ID>
Petición
Se pasa el ID del supervisor y el ID del vínculo a eliminar.
Ejemplo de petición:
DELETE /supervisor/1/students/3
Respuesta
Se devuelve un objeto con el vínculo entre ambos eliminado.
Ejemplo de respuesta:
{
"idStu": { ... },
"idSup": { ... },
"id": 3,
"role": "T"
}Leer sesiones de trabajo del supervisor
Operación
GET /supervisor/<supervisor-ID>/workingSessions
Petición
Se pasa el ID del supervisor en la la petición.
Ejemplo de petición:
GET /supervisor/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 acciones del supervisor
Operación
GET /supervisor/<supervisor-ID>/actions
Petición
Se pasa el ID del supervisor en la la petición.
Ejemplo de petición:
GET /supervisor/1/actions
Respuesta
Se devuelve un array de acciones.
Ejemplo de respuesta:
[
{
"id": 2,
"type": "Drag",
"timestamp": "2014-11-24T23:00:00.000Z",
"gpsLat": null,
"gpsLon": null,
"idConf": 1,
"idSup": 1
},
{
...
}
]