<< REST API
Leer pictogramas Leer pictograma Crear pictograma Modificar pictograma Eliminar pictograma
Leer expresiones del pictograma Leer expresión del pictograma Crear expresión del pictograma Modificar expresión del pictograma Eliminar expresión del pictograma
Leer etiquetas del pictograma Leer etiqueta del pictograma Asignar etiqueta al pictograma Eliminar etiqueta del pictograma
Leer pictogramas
Operación
GET /picto
Petición
No se pasa ningún valor.
Ejemplo de petición:
GET /picto
Respuesta
Se devuelve un array de pictogramas.
Ejemplo de respuesta:
[
{
"pictos": [],
"expressions": [],
"pictotags": [],
"aclPictos": [],
"configurations": [],
"idSou": {
"id": 1,
"name": "Food",
"description": "Food pictograms"
},
"idOwner": {
"id": 2,
"name": "Alfonso",
"surname": "Ureña",
"postalAddress": null,
"contactEmail": "laurena@ujaen.es",
"contactPhone": null,
"preferedLanguage": "ES"
},
"id": 1,
"uri": "/pictos/food/apple.png"
},
{
...
}
]Leer pictograma
Operación
GET /picto/<picto-ID>
Petición
Se pasa el ID del pictograma al final de la petición.
Ejemplo de petición:
GET /picto/2
Respuesta
Se devuelve el pictograma.
Ejemplo de respuesta:
{
"pictos": [],
"expressions": [],
"pictotags": [],
"aclPictos": [],
"configurations": [],
"idSou": {
"id": 1,
"name": "Food",
"description": "Food pictograms"
},
"idOwner": {
"id": 2,
"name": "Alfonso",
"surname": "Ureña",
"postalAddress": null,
"contactEmail": "laurena@ujaen.es",
"contactPhone": null,
"preferedLanguage": "ES"
},
"id": 2,
"uri": "/pictos/food/orange.png"
}Crear pictograma
Operación
POST /picto
Petición
Se pasa un objeto JSON con los siguientes campos:
-
uri(string): Ruta del pictograma -
idSou(integer): ID de la fuente del pictograma -
idOwner(integer): ID del supervisor propietario del pictograma (opcional) -
idPic(integer): ID del pictograma "padre". Se utiliza para trabajar con categorías de pictogramas (opcional)
Ejemplo de petición:
POST /picto
{
"uri": "/pictos/food/apple.png",
"idSou": 1,
"idOwner": 2
}Respuesta
Se devuelve un objeto con el pictograma creado.
Ejemplo de respuesta:
{
"uri": "/pictos/food/apple.png",
"id": 1,
"idSou": 1,
"idOwner": 2
}Modificar pictograma
Operación
PUT /picto/<picto-ID>
Petición
Se pasa el ID de pictograma al final de la petición y un objeto JSON con los campos que se desee modificar:
-
uri(string): Ruta del pictograma -
idSou(integer): ID de la fuente del pictograma -
idOwner(integer): ID del supervisor propietario del pictograma -
idPic(integer): ID del pictograma "padre". Se utiliza para trabajar con categorías de pictogramas
Ejemplo de petición:
PUT /picto/5
{
"idPic": 1
}Respuesta
Se devuelve un objeto con el pictograma modificado.
Ejemplo de respuesta:
{
"pictos": [],
"expressions": [],
"pictotags": [],
"aclPictos": [],
"configurations": [],
"idPic": {
"id": 1,
"uri": "/pictos/food/apple.png",
"idPic": null,
"idSou": 1,
"idOwner": 2
},
"idSou": { ... },
"idOwner": { ... },
"id": 5,
"uri": "/pictos/food/redapple.png"
}Eliminar pictograma
Operación
DELETE /picto/<picto-ID>
Petición
Se pasa el id del pictograma a eliminar al final de la petición.
Ejemplo de petición:
DELETE /picto/4
Respuesta
Se devuelve el pictograma eliminado.
Ejemplo de respuesta:
{
"pictos": [],
"expressions": [],
"pictotags": [],
"aclPictos": [],
"configurations": [],
"idSou": { ... },
"idOwner": { ... },
"id": 4,
"uri": "/pictos/food/strawberry.png"
}Leer expresiones del pictograma
Operación
GET /picto/<picto-ID>/expressions
Petición
Se pasa el ID del pictograma en la petición.
Ejemplo de petición:
GET /picto/2/expressions
Respuesta
Se devuelve un array de objetos JSON con las expresiones del pictograma.
Ejemplo de respuesta:
[
{
"id": 3,
"language": "ES",
"text": "Naranja",
"idPic": 2
},
{
...
}
]Leer expresión del pictograma
Operación
GET /picto/<picto-ID>/expressions/<expression-ID>
Petición
Se pasa el ID del pictograma y el ID de la expresión en la petición.
Ejemplo de petición:
GET /picto/2/expressions/3
Respuesta
Se devuelve un objeto JSON con la expresiónd el pictograma.
Ejemplo de respuesta:
{
"idPic": { ... },
"id": 3,
"language": "ES",
"text": "Naranja"
}Añadir expresión al pictograma
Operación
POST /picto/<picto-ID>/expressions
Petición
Se pasa el ID del pictograma en la petición y un objeto JSON con los siguientes campos:
-
language(string): Idioma de la expresión -
text(string): Texto de la expresión
Ejemplo de petición:
POST /picto/2/expressions
{
"language": "ES",
"text": "Naranja"
}Respuesta
Se devuelve un objeto con la expresión creada.
Ejemplo de respuesta:
{
"language": "ES",
"text": "Naranja",
"id": 3,
"idPic": 2
}Modificar valor de la expresión del pictograma
Operación
PUT /picto/<picto-ID>/expressions/<expression-ID>
Petición
Se pasa el ID del pictograma y el ID de la expresión en la petición y un objeto JSON con los campos que se deseen modificar:
-
language(string): Idioma de la expresión -
text(string): Texto de la expresión
Ejemplo de petición:
PUT /picto/2/expressions/3
{
"text": "Naranja mandarina"
}Respuesta
Se devuelve el objeto de la expresión con su nuevo valor.
Ejemplo de respuesta:
{
"idPic": { ... },
"id": 3,
"language": "ES",
"text": "Naranja mandarina"
}Eliminar expresión del pictograma
Operación
DELETE /picto/<picto-ID>/expressions/<expression-ID>
Petición
Se pasa el ID del pictograma y el ID de la expresión en la petición.
Ejemplo de petición:
DELETE /picto/2/expressions/3
Respuesta
Se devuelve un objeto con la expresión eliminada.
Ejemplo de respuesta:
{
"idPic": { ... },
"id": 3,
"language": "ES",
"text": "Naranja mandarina"
}Leer etiquetas del pictograma
Operación
GET /picto/<picto-ID>/tags
Petición
Se pasa el ID del pictograma en la petición.
Ejemplo de petición:
GET /picto/2/tags
Respuesta
Se devuelve un array de objetos JSON con las etiquetas del pictograma.
Ejemplo de respuesta:
[
{
"id": 1,
"idPic": 2,
"idTag": 1
},
{
...
}
]Leer etiqueta del pictograma
Operación
GET /picto/<picto-ID>/tags/<tag-ID>
Petición
Se pasa el ID del pictograma y el ID de la etiqueta en la petición.
Ejemplo de petición:
GET /picto/2/tags/1
Respuesta
Se devuelve un objeto JSON con la etiqueta el pictograma.
Ejemplo de respuesta:
{
"idPic": {
"id": 2,
"uri": "/pictos/food/orange.png",
"idPic": null,
"idSou": 1,
"idOwner": 2
},
"idTag": {
"id": 1,
"label": "food"
},
"id": 1
}Asignar etiqueta al pictograma
Operación
POST /picto/<picto-ID>/tags
Petición
Se pasa el ID del pictograma en la petición y un objeto JSON con los siguientes campos:
-
idTag(integer): ID de la etiqueta
Ejemplo de petición:
POST /picto/2/tags
{
"idTag": 5
}Respuesta
Se devuelve un objeto con la etiqueta asignada.
Ejemplo de respuesta:
{
"id": 2,
"idPic": 2,
"idTag": 5
}Eliminar etiqueta del pictograma
Operación
DELETE /picto/<picto-ID>/tags/<tag-ID>
Petición
Se pasa el ID del pictograma y el ID de la etiqueta en la petición.
Ejemplo de petición:
DELETE /picto/2/tags/2
Respuesta
Se devuelve un objeto con la etiqueta eliminada.
Ejemplo de respuesta:
{
"idPic": {
"id": 2,
"uri": "/pictos/food/orange.png",
"idPic": null,
"idSou": 1,
"idOwner": 2
},
"idTag": {
"id": 5,
"label": "fruits"
},
"id": 2
}