Patios Cordoba Api de datos abiertos


142KB Größe 15 Downloads 103 vistas
 

Modelo de API REST para http://b.patios.cordoba.es/    La aplicación que se muestra en ​http://patios.cordoba.es​ ​no contiene ningún dato aparte  de imágenes y logotipos. Toda la información que contiene la consulta en tiempo real a  través de una API Rest pública en el endpoint ​http://b.patios.cordoba.es​.    Con esta política y arquitectura de aplicaciones el ​Ayuntamiento de Córdoba​ quiere  reforzar la apertura y reutilización de datos públicos por parte de terceros. 

Documentación Listar Pois y Zonas Obtener listado de de Pois (en este caso patios) y Zonas con toda su información asociada y fotografías. Entendemos por Poi un punto de interés (Point of Interest). En el mayor de los casos un poi hace referencia a un patio, aunque también puede ser un punto de información o un aseo público entre otros.   Ruta 

http://b.patios.cordoba.es/api/v1/public/{locale}/json/pois_y_zonas   Verb 

[GET]   Parámetros 

Locale: (idioma), que puede ser: ‘en’(inglés), ‘fr’ (francés) y ‘es’ (español).    Retorna 

Dos objetos en json que contienen:   Array de objetos ‘Poi’ en formato json.  Array de objetos ‘Zoi’  en formato json.    Ejemplo de respuesta:  {"zonas":[ { "id":1, "nombre":"Santa Marina-San Agust\u00edn", "radio":380, "color":"#d9210b", "ruta":" [37.8902735468822, -4.777647256851196], [37.890341283430786,-4.77731466293335], [...] "lat":37.8895, "lng":-4.7736, "slug":"santa-marina-san-agustin" },

{...}], "pois":[ { "id":2, "tipo":"Patio", "slug":"conde-de-arenales-4", "nombre":"Conde de Arenales, 4", "concurso":true, "accesible":0, "descripcion":"Frente al Convento de Santa Marta[...] y la flor de cera.", "lat":37.886826, "lng":-4.774571, "tipopatio":null, "modalidadconcurso":"Arquitectura moderna", "imagen":"http:\/\/patios2016.s3.amazonaws.com\/fotos\/conde-de-arenales-4.jpg", "numero":"6", "zona_id":6 }, {...}]

Saturación de zonas Devuelve el nombre de la ruta, y su nivel de saturación (sólo si están saturadas). Ruta 

http://b.patios.cordoba.es/api/v1/public/{locale}/json/saturacion_zonas   Verb 

[GET]   Parámetros 

Locale: (idioma), que puede ser: ‘en’(inglés), ‘fr’ (francés) y ‘es’ (español).    Retorna 

Objeto en json que contiene un array de objetos ‘Zoi’ en formato json con: id, nombre, y  nivel.  Los niveles de saturación son: 0 (no saturado), 1(saturado), 2 (muy saturado).    Ejemplo de respuesta:         ​//Ninguna Zona saturada [ ] //Zona saturada [ { "id":1, "nombre":"Santa Marina-San Agust\u00edn", "nivel":1,

}, {...}], //Zona muy saturada [ { "id":1, "nombre":"Santa Marina-San Agust\u00edn", "nivel":2, }, {...}],

//Dos zonas saturadas [ { "id":5, "nombre":"San Lorenzo", "nivel":1 }, { "id":6, "nombre":"Regina Realejo", "nivel":2 }]

Saturación de zonas Devuelve un listado con todos los eventos y su información asociada de la agenda del festival de los patios Ruta 

http://b.patios.cordoba.es/api/v1/public/{locale}/json/agenda   Verb 

[GET]   Parámetros 

Locale: (idioma), que puede ser: ‘en’(inglés), ‘fr’ (francés) y ‘es’ (español).    Retorna 

Objeto en json que contiene un array de objetos ‘Evento’     Ejemplo de respuesta:  [{ "dia":"03-05-2016", "hora_inicio":"22:00", "hora_final":"22:00", "lugar":"Patio de las Campanas", "titulo":"Ciclo de Mu\u0301sica: La orquesta en los patios",

"descripcion":"Tri\u0301o de trombones: seleccio\u0301n de Tri\u0301os del Renacimiento y del Barroco Rafael Marti\u0301nez (trombo\u0301n tenor), Juan M. Morat (trombo\u0301n tenor), Pachi Muro (trombo\u0301n bajo).", "poi_id":22,"poi_slug": "siete-revueltas-1", "poi_nombre":"Siete Revueltas, 1"}, {}.....]

Buscar Poi por ​slug Devuelve información de poi Ruta 

http://b.patios.cordoba.es/api/v1/public/{locale}/json/poi/{slug}   Verb 

[GET]   Parámetros 

Locale: (idioma), que puede ser: ‘en’(inglés), ‘fr’ (francés) y ‘es’ (español). Slug: Identificador de nombre de patio generado automáticamente.   Retorna 

Objeto Poi o NULL     Ejemplo de respuesta:  { "id":2, "slug":"conde-de-arenales-4", "nombre":"Conde de Arenales, 4", "concurso":true, "accesible":0, "lat":37.886826, "lng":-4.774571, "tipopatio":null, "modalidadconcurso":"Arquitectura moderna", "urlImagen":"http:\/\/patios2016.s3.amazonaws.com\/fotos\/conde-de-arenales-4.jpg", "googlevr":null, "numero":"6", "descripcion":"Frente al Convento de Santa Marta, de la Orden Jer\u00f3nima, encontramos el patio de Concepci\u00f3n L\u00f3pez Ruiz, adquirido en el a\u00f1o 1982 y restaurado, destacando el suelo de m\u00e1rmol, los azulejos granadinos cubriendo las paredes del Patio y una hermosa fuente moderna de Rafael Garc\u00eda Rueda, inspirada en la de San Rafael. La casa, en la que viv\u00edan dos familias, data del a\u00f1o 1916, en la planta de abajo hab\u00eda cuadras, por lo que pudo ser una casa de labor. \r\nAntiguamente, junto al zagu\u00e1n, hab\u00eda una plater\u00eda y tambi\u00e9n se encontraba un pozo. Lleva varios a\u00f1os present\u00e1ndose a concurso. Las plantas son cuidadas por Concepci\u00f3n L\u00f3pez Ruiz y su hijo Vicente Flores, gran amante de las plantas. Destaca la gran variedad de plantas, entre las que nombraremos la alegr\u00eda de la casa, roiciso, graptop\u00e9talo, begonias, esparraguera, seflera y la flor de cera.", "zona_id":6}

Buscar Poi por ​slug Devuelve Pois de una zona Ruta 

http://b.patios.cordoba.es/api/v1/public/{locale}/json/pois/{slug}   Verb 

[GET]   Parámetros 

Locale: (idioma), que puede ser: ‘en’(inglés), ‘fr’ (francés) y ‘es’ (español). Slug: Identificador de nombre de patio generado automáticamente.   Retorna 

ArrayCollection de instancias Poi     Ejemplo de respuesta:  [{"id":20,"slug":"chaparro-3","nombre":"Chaparro, 3","concurso":true,"accesible":0,"lat":37.890377,"lng":-4.776839,"tipopatio":null,"modal idadconcurso":"Arquitectura moderna","urlImagen":"http:\/\/patios2016.s3.amazonaws.com\/fotos\/chaparro-3.jpg","goog levr":null,"numero":"10","descripcion":"La casa de Chaparro, 3, se construye en 1988 y la componen seis viviendas. Desde sus inicios, los vecinos que en ella habitan han mantenido la tradici\u00f3n de las casas de vecinos de C\u00f3rdoba. Aunque es una construcci\u00f3n de arquitectura moderna, el patio cuenta con una superficie de cien metros cuadrados y ha sido el lugar de encuentro de sus habitantes, espacio de convivencia y entorno donde compartir los buenos momentos. \r\nEn el fondo, podemos destacar un arco y una variedad floral muy heterog\u00e9nea que est\u00e1 compuesta desde el chirimoyo, el pomelo, el membrillo en fase de crecimiento, hasta las diversas plantas comunes como la gitanilla, el geranio, los claveles, calanchoes, ... y un ficus benjamina que adorna el centro de este amplio espacio. Es un patio cuya vegetaci\u00f3n se encuentra a\u00fan en la adolescencia de su vida. En el 2010 se presenta por primera vez al concurso con el objetivo de reivindicar la tradicional forma de vida de estas casas vecinales y mostrar a la ciudadan\u00eda que en el siglo XXI tambi\u00e9n se puede compartir un espacio y disfrutar de la antigua costumbre del Patio Cordob\u00e9s."},{"id":27,"slug":"parras-8","nombre":"Parras, 8","concurso":true,"accesible":0,"lat":37.887959,"lng":-4.772858,"tipopatio":null,"modal idadconcurso":"Arquitectura moderna","urlImagen":"http:\/\/patios2016.s3.amazonaws.com\/fotos\/parras-8.jpg","google vr":null,"numero":"14","descripcion":"Ubicado en una casa de m\u00e1s de 400 a\u00f1os de antig\u00fcedad este patio form\u00f3, junto con la vivienda n\u00famero seis de esta misma calle, parte de un convento pasando posteriormente a ser usadas ambas como cuartel. Se presenta por primera vez al concurso en el a\u00f1o 2005, siendo su propietaria M\u00aa Milagros Aznar Rubio, gran amante y coleccionista de plantas curiosas y ex\u00f3ticas, destacan: una dizigoteca, una araucaria, un limpiatubos... A pesar de ser un patio de arquitectura renovada conserva numerosos elementos antiguos, tales como dos pilas de lavar, un pozo compartido y cinco arcos de piedra recientemente dejados al descubierto."},{"id":29,"slug":"parras-6","nombre":"Parras,

6","concurso":true,"accesible":0,"lat":37.887753,"lng":-4.772791,"tipopatio":null,"modal idadconcurso":"Arquitectura antigua","urlImagen":"http:\/\/patios2016.s3.amazonaws.com\/fotos\/parras-6.jpg","google vr":null,"numero":"15","descripcion":"Este Patio, cuya casa se remonta a 1579, particip\u00f3 hasta 1980 en el Festival de Patios Cordobeses en tres ocasiones (1951, 1969, y 1980), produci\u00e9ndose un par\u00e9ntesis en la participaci\u00f3n de dicho Festival. Se volvi\u00f3 a incorporar al mismo en el a\u00f1o 2001 gracias a su actual propietaria, Rosario Cantillo Aban, que ha realizado un gran esfuerzo de cuidado y conservaci\u00f3n para abrirlo de nuevo a concurso y a todos aquellos apasionados por la tradici\u00f3n popular."} {...} ]

Listar instancias de Pois (slug y nombre) Listado de pois con los campos slug y nombre (para buscar más fácilmente) Ruta 

http://b.patios.cordoba.es/api/v1/public/json/pois   Verb 

[GET]   Parámetros    Retorna 

Devuelve array de instancias de poi con slug y nombre    Ejemplo de respuesta:  [{"slug":"mas-nombres","nombre":"m\u00e1s nombres"},{"slug":"nom-bre-de-pr-u-eba","nombre":"NOM BRE DE PR U EBA"},{"slug":"nombre-de-pa-tio-de-prueba","nombre":"NOMBRE DE PA TIO DE PRUEBA"},{"slug":"nombre-de-prueba","nombre":"nombre de prueba"},{"slug":"nombre-del-pario-de-prueba","nombre":"nombre del pario de prueba"},{"slug":"otro-nombre-de-patio-de-prueba","nombre":"OTRO NOMBRE DE PATIO DE PRUEBA"},{"slug":"patio-descripciones","nombre":"Patio descripciones"}]

Listar instancias de zonas (slug y nombre) Devuelve array de instancias de zona (zoi) con slug y nombre Ruta 

http://b.patios.cordoba.es/api/v1/public/json/zois   Verb 

[GET]   Parámetros   

Retorna 

Devuelve array de instancias de zoi con slug y nombre    Ejemplo de respuesta:  [{"slug":"mas-nombres-de-prueba","nombre":"m\u00e1s nombres de prueba"},{"slug":"nombre-de-prueba","nombre":"nombre de prueba"},{"slug":"nombre-de-prueba-despues","nombre":"NOMBRE DE prueba despu\u00e9s"},{"slug":"nombre-de-prueba-pepinoso","nombre":"Nombre de Prueba PEPINOSO"},{"slug":"nombre-de-prueba-pinosisimo","nombre":"nombre de PRUEBA pinos\u00edsimo"},{"slug":"nombre-de-zon-a-de-prueba","nombre":"NOMBRE DE ZON A DE PRUEBA"},{"slug":"ot-tro-nombre-de-73846-oryueba","nombre":"OT TRO NOMBRE DE 73846 ORYUEBA"}]

Buscar Poi por slug (Diferente del anterior, puede devolver más de un  elemento). Devuelve información de poi Ruta 

http://b.patios.cordoba.es/api/v1/public/json/zois   Verb 

[GET]   Parámetros 

Locale: (idioma), que puede ser: ‘en’(inglés), ‘fr’ (francés) y ‘es’ (español). Slug: Identificador de nombre de patio generado automáticamente.   Retorna 

Array de objetos Poi    Ejemplo de respuesta:  [{"slug":"mas-nombres-de-prueba","nombre":"m\u00e1s nombres de prueba"},{"slug":"nombre-de-prueba","nombre":"nombre de prueba"},{"slug":"nombre-de-prueba-despues","nombre":"NOMBRE DE prueba despu\u00e9s"},{"slug":"nombre-de-prueba-pepinoso","nombre":"Nombre de Prueba PEPINOSO"},{"slug":"nombre-de-prueba-pinosisimo","nombre":"nombre de PRUEBA pinos\u00edsimo"},{"slug":"nombre-de-zon-a-de-prueba","nombre":"NOMBRE DE ZON A DE PRUEBA"},{"slug":"ot-tro-nombre-de-73846-oryueba","nombre":"OT TRO NOMBRE DE 73846 ORYUEBA"}]