Estos endpoints son métodos del caso de uso que tienen el objetivo de crear, obtener información o eliminar una zona de carga y descarga.
Crear zona de carga y descarga
-
Method: POST
-
URL: {baseUrl}/v1/area
-
Body:
{ "municipalityIneCode":50297, "loadingAreaId":2, "address":"abc", "postalCode":1, "timetable":"abc", "capacity":0, "width": 2.5, "length": 4.7, "observations": "Observaciones", "timestamp": "2023-09-26 00:00:00", "geoJsonAddress":{ "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 la zona de carga y descarga
El evento es la parte principal de esta API de ingesta de datos. Con este evento se podrá actualizar la información de cada zona de carga y descarga.
-
Method: PUT
-
URL: {baseUrl}/v1/area
-
Actualiza los datos de una zona de carga y descarga
{ "municipalityIneCode":50297, "loadingAreaId":2, "address":"abcdef", "postalCode":1, "timetable":"newTimeTable", "capacity":0, "width": 2.5, "length": 4.7, "observations": "Observaciones", "timestamp": "2023-09-26 00:00:00", "geoJsonAddress":{ "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] ] ] } }
*** = Campo requerido**
-
municipalityIneCode * (número entero): identificador del municipio donde se genera el evento según el INE
-
loadingAreaId * (número entero): identificador de la zona de carga y descarga
-
address (texto): dirección de la zona de carga y descarga
-
postalCode (número entero): código postal de la zona de carga y descarga
-
timetable (texto): horario de la zona de carga y descarga
-
capacity (número entero): capacidad de la zona de carga y descarga
-
Width (Número decimal): Anchura de la zona de carga y descarga
-
Length (Número decimal): Longitud total de la zona de carga y descarga
-
geoJsonAddress: información geoespacial de la zona de carga y descarga
-
type (texto): tipo de zona de carga y descarga
-
coordinates (número decimal): array de coordenadas de la zona de carga y descarga
-
Obtener información de las zonas de carga y descarga de un municipio
-
Method: GET
-
URL: {baseUrl}/v1/area/{municipalityIneCode}
-
Respuesta:
[ { "municipalityIneCode": 50297, "loadingAreaId": "1", "postalCode": 1, "observations": "Observaciones", "address": "abcdef", "timetable": "newTimeTable", "capacity": 0, "geoJsonAddress": { "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] ] ] }, "timestamp": "2023-09-26 00:00:00" }, { "municipalityIneCode": 50297, "loadingAreaId": "2", "postalCode": 1, "observations": "Observaciones", "address": "abcdefg", "timetable": "abc", "capacity": 10, "length": 4.7, "width": 2.5, "geoJsonAddress": { "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] ] ] }, "timestamp": "2023-09-26 00:00:00" } ]
Obtener información de una zona de carga y descarga
-
Method: GET
-
URL: {baseUrl}/v1/area/{municipalityIneCode}/{loadingAreaId}
-
Respuesta:
[ { "municipalityIneCode": 50297, "loadingAreaId": "1", "postalCode": 1, "observations": "Observaciones", "address": "abcdef", "timetable": "newTimeTable", "capacity": 0, "geoJsonAddress": { "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] ] ] }, "timestamp": "2023-09-26 00:00:00" } ]
Borrar zona de carga y descarga
-
Method: DEL
-
URL: {baseUrl}/v1/area/{municipalityIneCode}/{loadingAreaId}