Estos endpoints son métodos del caso de uso que tienen el objetivo de crear, actualizar, obtener información o eliminar un aparcamiento.
Crear aparcamiento
-
Method: POST
-
URL: {baseUrl}/v1/parking
-
Body:
{ "cityIne":50297, "parkingName":"abcd", "parkingId":1, "address":"abc", "cp":1, "observations":"abc", "accessConditions":"abc", "timetable":"abc", "capacity":0, "free": 5, "geometry":{ "type":"Polygon", "coordinates":[ [ [-0.864299,41.646176],[-0.864162,41.646250], [-0.864135,41.646412],[-0.864408,41.646432], [-0.864453,41.646200],[-0.864299,41.646176] ] ] } }
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)
[ { "cityIne":50297, "parkingId":1, "free":5, "capacity":6, "timestamp":"2021-03-15T13:34:00.000Z" } ]
*** = Campo requerido**
-
cityIne(número entero): identificador del municipio donde se genera el evento según el INE
-
parkingId (número entero): identificador del aparcamiento
-
free(número entero): plazas libres del aparcamiento
-
capacity (número entero): capacidad total del aparcamiento
-
timestamp (fecha UTC): fecha y hora en formato UTC del momento en el que el parking se ha actualizado por última vez. Es necesario que no sea un timestamp futuro con respecto a la hora UTC actual. La fecha debe finalizar con el caracter 'Z' que marca que está en UTC
Obtener información de los aparcamientos de un municipio
-
Method: GET
-
URL: {baseUrl}/v1/parking/{cityIne}
-
Respuesta:
[ { "cityIne": 50297, "cityName": "Zaragoza", "parkingName": "abcd", "parkingId": "99", "cp": 1, "address": "abc", "timetable": "abc", "capacity": 0, "geometry": { "type": "Polygon", "coordinates":[ [ [-0.864299,41.646176],[-0.864162,41.646250], [-0.864135,41.646412],[-0.864408,41.646432], [-0.864453,41.646200],[-0.864299,41.646176] ] ] } }, { "cityIne": 50297, "cityName": "Zaragoza", "parkingName": "abcd", "parkingId": "1", "cp": 1, "address": "abc", "timetable": "abc", "capacity": 5, "free": 4, "geometry": { "type": "Polygon", "coordinates":[ [ [-0.864299,41.646176],[-0.864162,41.646250], [-0.864135,41.646412],[-0.864408,41.646432], [-0.864453,41.646200],[-0.864299,41.646176] ] ] } } ]
Obtener información de un aparcamiento
-
Method: GET
-
URL: {baseUrl}/v1/parking/{cityIne}/{parkingId}
-
Respuesta:
[ { "cityIne": 50297, "cityName": "Zaragoza", "parkingName": "abcd", "parkingId": "1", "cp": 1, "address": "abc", "timetable": "abc", "capacity": 0, "geometry": { "type": "Polygon", "coordinates":[ [ [-0.864299,41.646176],[-0.864162,41.646250], [-0.864135,41.646412],[-0.864408,41.646432], [-0.864453,41.646200],[-0.864299,41.646176] ] ] } } ]
Borrar aparcamiento
-
Method: DEL
-
URL: {baseUrl}/v1/parking/{cityIne}/{parkingId}