Estos endpoints son métodos del caso de uso que tienen el objetivo de crear, actualizar, obtener información o eliminar un aparcamiento.
Creación de un aparcamiento
-
Method: POST
-
URL: {baseUrl}/v1/parking
-
Body:
[ { "cityIne": 50297, "parkingName": "Parking Plaza España", "parkingId": 1, "address": "C. del Coso, 45", "cp": 50003, "observations": "Primera planta solo plazas reservadas", "accessConditions": "Altura máxima 2,10 m", "capacity": 168, "free": 23, "geometry": { "type": "Polygon", "coordinates": [ [ [-0.880468,41.652120], [-0.880676,41.652234], [-0.880306,41.652211], [-0.880575,41.652344], [-0.880676,41.652234], [-0.880468,41.652120] ] ] }, "timestamp": "2022-03-07T12:31:00", "timetable": { "exceptions":"Excepto fútbol", "days":[ { "day":"J", "timeRanges":[ { "startTime":"08:00:00", "endTime":"17:00:00" }, { "startTime":"18:00:00", "endTime":"22:00:00" }, { "startTime":"22:30:00", "endTime":"23:55:00" } ] }, { "day":"D", "timeRanges":[ { "startTime":"08:00:00", "endTime":"22:00:00" } ] } ] } } ]
(*)= Campo requerido
-
(*)cityIne: Identificador del municipio donde se genera el evento según el INE.
-
cityName: Ciudad en la que se encuentra el aparcamiento.
-
(*)parkingName: Nombre del aparcamiento.
-
(*)parkingId: Identificador del aparcamiento.
-
address: Dirección del aparcamiento.
-
(*)cp: Código postal del aparcamiento.
-
observations:Información adicional del aparcamiento.
-
accessConditions: Condiciones de acceso especiales del aparcamiento.
-
(*)free: Plazas libres del aparcamiento.
-
(*)capacity: Capacidad del aparcamiento.
-
(*)timestamp: Fecha de última actualización de la información del aparcamiento.
-
(*)Timetable: Horario de funcionamiento del aparcamiento por día de la semana.
-
(*)geometry: información geoespacial del aparcamiento.
Actualización de un aparcamiento
El evento es la parte principal de esta API de ingesta de datos. Con este evento se podrá actualizar la información de cada aparcamiento.
-
Method: PUT
-
URL: {baseUrl}/v1/parking
-
Actualiza los datos de un aparcamiento (cityIne, parkingId, free, capacity,timestamp)
[ { "cityIne":50297, "parkingId":1, "free":58, "capacity":168, "timestamp":"2022-03-07T12:31:00" } ]
(*)= Campo requerido
· (*)cityIne: Identificador del municipio donde se genera el evento según el INE.
· (*)parkingId: Identificador del aparcamiento.
· (*)free: Plazas libres del aparcamiento.
· (*)capacity: Capacidad del aparcamiento.
· (*)timestamp: Fecha de actualización de la información.
· cityName: Ciudad en la que se encuentra el aparcamiento.
· parkingName: Nombre del aparcamiento.
· address: Dirección del aparcamiento.
· cp: Código postal del aparcamiento.
· observations:Información adicional del aparcamiento.
· accessConditions: Condiciones de acceso especiales del aparcamiento.
· Timetable: Horario de funcionamiento del aparcamiento por día de la semana.
· geometry: información geoespacial del aparcamiento.
Obtener información de los aparcamientos de un municipio
-
Method: GET
-
URL: {baseUrl}/v1/parking/{cityIne}
-
Respuesta:
[ { "cityIne": 50297, "parkingName": "Parking Plaza España", "parkingId": 1, "address": "C. del Coso, 45", "cp": 50003, "observations": "Primera planta solo plazas reservadas", "accessConditions": "Altura máxima 2,10 m", "capacity": 168, "free": 23, "geometry": { "type": "Polygon", "coordinates": [ [ [-0.880468,41.652120], [-0.880676,41.652234], [-0.880306,41.652211], [-0.880575,41.652344], [-0.880676,41.652234], [-0.880468,41.652120] ] ] }, "timestamp": "2022-03-07T12:31:00", "timetable": { "exceptions":"Excepto fútbol", "days":[ { "day":"J", "timeRanges":[ { "startTime":"08:00:00", "endTime":"17:00:00" }, { "startTime":"18:00:00", "endTime":"22:00:00" }, { "startTime":"22:30:00", "endTime":"23:55:00" } ] }, { "day":"D", "timeRanges":[ { "startTime":"08:00:00", "endTime":"22:00:00" } ] } ] } } ]
Obtener información de un aparcamiento
-
Method: GET
-
URL: {baseUrl}/v1/parking/{cityIne}/{parkingId}
-
Respuesta:
[ { "cityIne": 50297, "parkingName": "Parking Plaza España", "parkingId": 1, "address": "C. del Coso, 45", "cp": 50003, "observations": "Primera planta solo plazas reservadas", "accessConditions": "Altura máxima 2,10 m", "capacity": 168, "free": 23, "geometry": { "type": "Polygon", "coordinates": [ [ [-0.880468,41.652120], [-0.880676,41.652234], [-0.880306,41.652211], [-0.880575,41.652344], [-0.880676,41.652234], [-0.880468,41.652120] ] ] }, "timestamp": "2022-03-07T12:31:00", "timetable": { "exceptions":"Excepto fútbol", "days":[ { "day":"J", "timeRanges":[ { "startTime":"08:00:00", "endTime":"17:00:00" }, { "startTime":"18:00:00", "endTime":"22:00:00" }, { "startTime":"22:30:00", "endTime":"23:55:00" } ] }, { "day":"D", "timeRanges":[ { "startTime":"08:00:00", "endTime":"22:00:00" } ] } ] } } ]
Borrar aparcamiento
-
Method: DEL
-
URL: {baseUrl}/v1/parking/{cityIne}/{parkingId}