### Actuator - GET /actuator Source: https://direcciones.ide.uy/v2/api-docs Provides links to other actuators. ```APIDOC ## GET /actuator ### Description This endpoint provides a list of available actuator endpoints. ### Method GET ### Endpoint /actuator ### Parameters None ### Request Example ``` GET /actuator ``` ### Response #### Success Response (200) - **_links** (object) - An object containing links to various actuator endpoints. #### Response Example ```json { "_links": { "self": {"href": "http://direcciones.ide.uy/actuator", "templated": false}, "beans": {"href": "http://direcciones.ide.uy/actuator/beans", "templated": false}, "caches": {"href": "http://direcciones.ide.uy/actuator/caches", "templated": false}, "conditions": {"href": "http://direcciones.ide.uy/actuator/conditions", "templated": false} } } ``` ``` -------------------------------- ### Actuator Conditions - GET /actuator/conditions Source: https://direcciones.ide.uy/v2/api-docs Exposes the conditions of the application. ```APIDOC ## GET /actuator/conditions ### Description This endpoint displays the conditions that were evaluated during the application startup. ### Method GET ### Endpoint /actuator/conditions ### Parameters None ### Request Example ``` GET /actuator/conditions ``` ### Response #### Success Response (200) - **conditions** (object) - An object detailing the conditions evaluated. #### Response Example ```json { "conditions": { "combined": [ { "condition": "OnPropertyCondition", "entity": "org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration", "message": "'spring.datasource.type' did not contain 'org.springframework.jdbc.datasource.embedded.EmbeddedDatabase'". } ] } } ``` ``` -------------------------------- ### Geocode API - GET Source: https://direcciones.ide.uy/v2/api-docs This section details the GET requests for geocoding services, including finding streets, addresses, and points of interest. It also explains the geocoding result states. ```APIDOC ## GET /geocode ### Description This endpoint allows you to search for streets, addresses, and points of interest. The results may include a geocoding status indicating if the result is valid or approximate. ### Method GET ### Endpoint /geocode ### Parameters #### Query Parameters - **address** (string) - Required - The address or street name to search for. - **apiKey** (string) - Required - Your API key for authentication. ### Request Example ``` GET /geocode?address=Avenida+Libertador&apiKey=YOUR_API_KEY ``` ### Response #### Success Response (200) - **results** (array) - An array of geocoding results. - **state** (string) - The geocoding state (e.g., 'VALID', 'APPROXIMATE'). - **stateMsg** (string) - A message describing the geocoding state. - **location** (object) - The geographic location of the result. - **lat** (number) - Latitude. - **lon** (number) - Longitude. #### Response Example ```json { "results": [ { "state": "VALID", "stateMsg": "OK", "location": { "lat": -34.8858, "lon": -56.1645 } } ] } ``` ``` -------------------------------- ### Actuator Caches - GET /actuator/caches Source: https://direcciones.ide.uy/v2/api-docs Exposes the caches of the application. ```APIDOC ## GET /actuator/caches ### Description This endpoint lists all the available caches in the application. ### Method GET ### Endpoint /actuator/caches ### Parameters None ### Request Example ``` GET /actuator/caches ``` ### Response #### Success Response (200) - **caches** (object) - An object containing cache names and their details. #### Response Example ```json { "caches": { "users": {"name": "users", "target": "ConcurrentMapCache"}, "products": {"name": "products", "target": "ConcurrentMapCache"} } } ``` ``` -------------------------------- ### Actuator Beans - GET /actuator/beans Source: https://direcciones.ide.uy/v2/api-docs Exposes the beans of the application. ```APIDOC ## GET /actuator/beans ### Description This endpoint lists all the beans managed by the Spring application context. ### Method GET ### Endpoint /actuator/beans ### Parameters #### Query Parameters - **full** (boolean) - Optional - If true, returns full bean details. ### Request Example ``` GET /actuator/beans?full=true ``` ### Response #### Success Response (200) - **beans** (object) - An object containing beans and their details. #### Response Example ```json { "beans": { "application": { "aliases": [], "type": "com.example.MyApp", "dependencies": ["dataSource", "entityManagerFactory"] } // ... more beans } } ``` ``` -------------------------------- ### Actuator Cache by Name - GET /actuator/caches/{cache} Source: https://direcciones.ide.uy/v2/api-docs Exposes the cache by name. ```APIDOC ## GET /actuator/caches/{cache} ### Description This endpoint retrieves details about a specific cache by its name. ### Method GET ### Endpoint /actuator/caches/{cache} ### Parameters #### Path Parameters - **cache** (string) - Required - The name of the cache to retrieve. ### Request Example ``` GET /actuator/caches/users ``` ### Response #### Success Response (200) - **name** (string) - The name of the cache. - **target** (string) - The type of cache implementation. #### Response Example ```json { "name": "users", "target": "ConcurrentMapCache" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcPuntoNotable Source: https://direcciones.ide.uy/swagger-ui Retrieves notable points (points of interest). ```APIDOC ## GET /api/v1/geocode/direcPuntoNotable ### Description Retrieves notable points (points of interest). ### Method GET ### Endpoint /api/v1/geocode/direcPuntoNotable ### Parameters #### Query Parameters - **[parameter_name]** (type) - Required/Optional - Description of the parameter ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/candidates Source: https://direcciones.ide.uy/swagger-ui Searches for candidates, typically used for autocompletion functionalities. ```APIDOC ## GET /api/v1/geocode/candidates ### Description Searches for candidates, typically used for autocompletion functionalities. ### Method GET ### Endpoint /api/v1/geocode/candidates ### Parameters #### Query Parameters - **[parameter_name]** (type) - Required/Optional - Description of the parameter ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcPadron Source: https://direcciones.ide.uy/swagger-ui Retrieves addresses by selecting based on a 'padron' within a specific department and locality. Example: http://{server}:{port}/api/v1/geocode/direcPadron?departamento=Cerro Largo&localidad=Melo&padron=562 ```APIDOC ## GET /api/v1/geocode/direcPadron ### Description Retrieves addresses by selecting based on a 'padron' within a specific department and locality. Example: http://{server}:{port}/api/v1/geocode/direcPadron?departamento=Cerro Largo&localidad=Melo&padron=562 ### Method GET ### Endpoint /api/v1/geocode/direcPadron ### Parameters #### Query Parameters - **departamento** (string) - Required - The name of the department. - **localidad** (string) - Required - The name of the locality. - **padron** (string) - Required - The padron number. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcUnica Source: https://direcciones.ide.uy/v2/api-docs Geocodes a single, unique address. The 'q' parameter is mandatory for the address query. The 'limit' parameter can be used for testing. ```APIDOC ## GET /api/v1/geocode/direcUnica ### Description Geocodes a unique address. The 'q' parameter is mandatory for the address query. The 'limit' parameter can be used for testing. ### Method GET ### Endpoint /api/v1/geocode/direcUnica ### Parameters #### Query Parameters - **q** (string) - Required - The unique address to geocode. - **limit** (integer) - Optional - The limit for results, defaults to 1. ### Request Example ```json { "example": "GET /api/v1/geocode/direcUnica?q=Avenida Siempreviva 742&limit=1" } ``` ### Response #### Success Response (200) - **GeocoderResult** (array) - An array of geocoding results. #### Response Example ```json { "example": [ { "address": "Avenida Siempreviva 742, Springfield, USA" } ] } ``` ``` -------------------------------- ### GET /api/v1/geocode/find Source: https://direcciones.ide.uy/swagger-ui Searches for addresses by exact match of several parameters. Use after autocompletion. ```APIDOC ## GET /api/v1/geocode/find ### Description Searches for addresses by exact match of several parameters. Use after autocompletion. ### Method GET ### Endpoint /api/v1/geocode/find ### Parameters #### Query Parameters - **param1** (string) - Required - Description of parameter 1. - **param2** (string) - Optional - Description of parameter 2. ### Response #### Success Response (200) - **direccion** (string) - The found address. #### Response Example ```json { "direccion": "Calle Exacta 789, Ciudad" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcManzaSolar Source: https://direcciones.ide.uy/swagger-ui Retrieves addresses associated with a specific block (manzana) and lot (solar). ```APIDOC ## GET /api/v1/geocode/direcManzaSolar ### Description Retrieves addresses associated with a specific block (manzana) and lot (solar). ### Method GET ### Endpoint /api/v1/geocode/direcManzaSolar ### Parameters #### Query Parameters - **manzana** (string) - Required - The block number. - **solar** (string) - Required - The lot number. ### Response #### Success Response (200) - **direccion** (string) - The associated address. #### Response Example ```json { "direccion": "Calle Ejemplo 123, Montevideo" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcManzaSolar Source: https://direcciones.ide.uy/swagger-ui Retrieves addresses associated with a specific block (manzana) and lot (solar). ```APIDOC ## GET /api/v1/geocode/direcManzaSolar ### Description Retrieves addresses associated with a specific block (manzana) and lot (solar). ### Method GET ### Endpoint /api/v1/geocode/direcManzaSolar ### Parameters #### Query Parameters - **manzana** (string) - Required - The block identifier. - **solar** (string) - Required - The lot identifier. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcPuntoNotable Source: https://direcciones.ide.uy/swagger-ui Retrieves addresses by selecting a Point of Interest (POI) within a department. ```APIDOC ## GET /api/v1/geocode/direcPuntoNotable ### Description Retrieves addresses by selecting a Point of Interest (POI) within a department. ### Method GET ### Endpoint /api/v1/geocode/direcPuntoNotable ### Parameters #### Query Parameters - **departamento** (string) - Required - The department name. - **nombre** (string) - Required - The name of the Point of Interest. ### Request Example ``` http://{server}:{port}/api/v1/geocode/direcPuntoNotable?departamento=Cerro Largo&nombre=Correos ``` ### Response #### Success Response (200) - **direccion** (string) - The associated address. #### Response Example ```json { "direccion": "Dirección de Correos, Cerro Largo" } ``` ``` -------------------------------- ### Get Point on Route by Kilometer Source: https://direcciones.ide.uy/swagger-ui Given a route and a kilometer marker, returns a point located on that route. ```APIDOC ## GET /api/v1/geocode/rutakm ### Description Given a route and a kilometer marker, returns a point located on that route. ### Method GET ### Endpoint /api/v1/geocode/rutakm ### Parameters #### Query Parameters - **ruta** (string) - Required - The name or identifier of the route. - **km** (number) - Required - The kilometer marker on the route. ``` -------------------------------- ### GET /api/v0/geocode/reverse Source: https://direcciones.ide.uy/v2/api-docs Reverse geocoding service that takes latitude and longitude coordinates (in EPSG:4326) and returns the corresponding address information. ```APIDOC ## GET /api/v0/geocode/reverse ### Description Performs reverse geocoding to find an address based on geographic coordinates. ### Method GET ### Endpoint /api/v0/geocode/reverse ### Parameters #### Query Parameters - **latitud** (number) - Required - The latitude coordinate. - **longitud** (number) - Required - The longitude coordinate. - **limit** (integer) - Optional - The maximum number of results to return. Defaults to 10. ### Request Example ```json { "latitud": -34.9011, "longitud": -56.1645, "limit": 5 } ``` ### Response #### Success Response (200) - **[]** (array) - An array of `GeocoderResult` objects, each containing address details. #### Response Example ```json [ { "direccion": "18 de Julio 1234, Montevideo", "latitud": -34.9011, "longitud": -56.1645 } ] ``` ``` -------------------------------- ### GET /api/v1/geocode/reverse Source: https://direcciones.ide.uy/swagger-ui Performs reverse geocoding, converting latitude and longitude (EPSG:4326) into an address. ```APIDOC ## GET /api/v1/geocode/reverse ### Description Performs reverse geocoding. Converts latitude and longitude (in EPSG:4326) into an address. ### Method GET ### Endpoint /api/v1/geocode/reverse ### Parameters #### Query Parameters - **lat** (number) - Required - The latitude coordinate. - **lon** (number) - Required - The longitude coordinate. ### Response #### Success Response (200) - **direccion** (string) - The address corresponding to the coordinates. #### Response Example ```json { "direccion": "Calle Ejemplo 101, Montevideo" } ``` ``` -------------------------------- ### GET /api/v0/geocode/reverse Source: https://direcciones.ide.uy/swagger-ui Performs reverse geocoding using latitude and longitude coordinates in EPSG:4326. ```APIDOC ## GET /api/v0/geocode/reverse ### Description Performs reverse geocoding using latitude and longitude coordinates in EPSG:4326. ### Method GET ### Endpoint /api/v0/geocode/reverse ### Parameters #### Query Parameters - **[parameter_name]** (type) - Required/Optional - Description of the parameter ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/rutakm Source: https://direcciones.ide.uy/swagger-ui Given a route and kilometer marker, returns a point located on that route. ```APIDOC ## GET /api/v1/geocode/rutakm ### Description Given a route and kilometer marker, returns a point located on that route. ### Method GET ### Endpoint /api/v1/geocode/rutakm ### Parameters #### Query Parameters - **ruta** (string) - Required - The name or identifier of the route. - **km** (number) - Required - The kilometer marker on the route. ### Response #### Success Response (200) - **punto** (object) - The coordinates of the point on the route. - **lat** (number) - The latitude. - **lon** (number) - The longitude. #### Response Example ```json { "punto": { "lat": -34.9, "lon": -55.5 } } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcPadron Source: https://direcciones.ide.uy/swagger-ui Retrieves addresses by selecting a cadastral number (padron) within a department and locality. ```APIDOC ## GET /api/v1/geocode/direcPadron ### Description Retrieves addresses by selecting a cadastral number (padron) within a department and locality. ### Method GET ### Endpoint /api/v1/geocode/direcPadron ### Parameters #### Query Parameters - **departamento** (string) - Required - The department name. - **localidad** (string) - Required - The locality name. - **padron** (string) - Required - The cadastral number. ### Request Example ``` http://{server}:{port}/api/v1/geocode/direcPadron?departamento=Cerro Largo&localidad=Melo&padron=562 ``` ### Response #### Success Response (200) - **direccion** (string) - The associated address. #### Response Example ```json { "direccion": "Calle Ejemplo 456, Melo" } ``` ``` -------------------------------- ### GET /api/v0/geocode/localidades Source: https://direcciones.ide.uy/v2/api-docs The locality search service returns a set of localities for a given department. Each locality includes its identifier, name, postal code, and alias. ```APIDOC ## GET /api/v0/geocode/localidades ### Description Retrieves a list of localities within a specified department. ### Method GET ### Endpoint /api/v0/geocode/localidades ### Parameters #### Query Parameters - **departamento** (string) - Required - The identifier of the department to search within. - **alias** (boolean) - Optional - If true, includes locality aliases in the response. ### Request Example ```json { "departamento": "Montevideo", "alias": true } ``` ### Response #### Success Response (200) - **[]** (array) - An array of `LocalidadResultV0` objects, each containing locality details. #### Response Example ```json [ { "id": "1", "nombre": "Montevideo", "codigoPostal": "11000", "alias": "MVD" } ] ``` ``` -------------------------------- ### GET /api/v1/geocode/candidates Source: https://direcciones.ide.uy/v2/api-docs Search for geocoding candidates, useful for autocompletion. The endpoint can filter results to include only localities if specified. ```APIDOC ## GET /api/v1/geocode/candidates ### Description Searches for geocoding candidates to aid in autocompletion functionalities. Can optionally filter for localities only. ### Method GET ### Endpoint /api/v1/geocode/candidates ### Parameters #### Query Parameters - **q** (string) - Required - The query string for searching candidates. - **limit** (integer) - Optional - The maximum number of results to return. Defaults to 10. - **soloLocalidad** (boolean) - Optional - If true, only returns locality candidates. Defaults to false. ### Request Example ```json { "q": "sucre", "soloLocalidad": false, "limit": 100 } ``` ### Response #### Success Response (200) - **[]** (array) - An array of `GeocoderResult` objects, each representing a geocoding candidate. #### Response Example ```json [ { "direccion": "Sucre 123, Montevideo", "latitud": -34.8950, "longitud": -56.1800 } ] ``` ``` -------------------------------- ### GET /api/v0/geocode/SugerenciaCalleCompleta Source: https://direcciones.ide.uy/swagger-ui Provides street suggestions based on a search query. The service returns streets formatted as 'street, locality, department', ordered by the number of associated addresses. Useful for address autocompletion. ```APIDOC ## GET /api/v0/geocode/SugerenciaCalleCompleta ### Description Provides street suggestions based on a search query ('entrada' parameter). The service returns streets formatted as 'street, locality, department', ordered by the number of associated addresses in descending order. Useful for address autocompletion. ### Method GET ### Endpoint /api/v0/geocode/SugerenciaCalleCompleta ### Parameters #### Query Parameters - **entrada** (string) - Required - Free text representing an address, can be part of a street even with incomplete words (e.g., "Buenos Air") and can contain the door number. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcManzaSolar Source: https://direcciones.ide.uy/v2/api-docs Retrieves addresses associated with a specific manzana (block) and solar (lot). Requires department and locality as query parameters. ```APIDOC ## GET /api/v1/geocode/direcManzaSolar ### Description Returns the addresses associated with a block (manzana) and lot (solar). ### Method GET ### Endpoint /api/v1/geocode/direcManzaSolar ### Parameters #### Query Parameters - **departamento** (string) - Required - The department to search within. - **localidad** (string) - Required - The locality to search within. - **manzana** (integer) - Required - The block number. - **solar** (integer) - Required - The lot number. - **limit** (integer) - Optional - The maximum number of results to return. Defaults to 100. ### Request Example ```json { "example": "GET /api/v1/geocode/direcManzaSolar?departamento=Montevideo&localidad=Pocitos&manzana=100&solar=5&limit=10" } ``` ### Response #### Success Response (200) - **GeocoderResult** (array) - An array of geocoding results. #### Response Example ```json { "example": [ { "address": "Calle Falsa 123, Montevideo, Uruguay" } ] } ``` ``` -------------------------------- ### GET /api/v0/geocode/localidades Source: https://direcciones.ide.uy/swagger-ui Retrieves a list of localities within a specified department. Each locality includes an identifier, name, postal code, and alias. ```APIDOC ## GET /api/v0/geocode/localidades ### Description Retrieves a list of localities within a specified department. Each locality includes an identifier, name, postal code, and alias. ### Method GET ### Endpoint /api/v0/geocode/localidades ### Parameters #### Query Parameters - **[parameter_name]** (type) - Required/Optional - Description of the parameter ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/find Source: https://direcciones.ide.uy/v2/api-docs Searches for addresses based on exact matches of various parameters. This endpoint is recommended for use after autocompletion. ```APIDOC ## GET /api/v1/geocode/find ### Description Searches for addresses by exact match of various parameters. Recommended to use after autocompletion. Possible values for type: calle, solar, inmueble, ruta, esquina, localidad. ### Method GET ### Endpoint /api/v1/geocode/find ### Parameters #### Query Parameters - **type** (string) - Required - The type of address component to search by (e.g., calle, solar). - **departamento** (string) - Optional - The department to filter by. - **idcalle** (string) - Optional - The ID of the street. - **idcalleEsq** (string) - Optional - The ID of the intersecting street. - **inmueble** (string) - Optional - The property number. - **km** (string) - Optional - The kilometer marker (for routes). - **letra** (string) - Optional - A letter suffix for the address. - **localidad** (string) - Optional - The locality to filter by. - **manzana** (string) - Optional - The block number. - **nomvia** (string) - Optional - The name of the street. - **solar** (string) - Optional - The lot number. - **ruta** (string) - Optional - The route number. - **tipoVia** (string) - Optional - The type of street (e.g., avenue, street). ### Request Example ```json { "example": "GET /api/v1/geocode/find?type=calle&idcalle=8096&departamento=Montevideo" } ``` ### Response #### Success Response (200) - **GeocoderResult** (array) - An array of geocoding results. #### Response Example ```json { "example": [ { "address": "Calle Principal 123, Montevideo, Uruguay" } ] } ``` ``` -------------------------------- ### GET /api/v1/geocode/direcPuntoNotable Source: https://direcciones.ide.uy/v2/api-docs Retrieves addresses for points of interest (POIs) within a given department. Searchable by the name of the point of interest. ```APIDOC ## GET /api/v1/geocode/direcPuntoNotable ### Description Returns addresses by selecting a point of interest (POI) within a department. ### Method GET ### Endpoint /api/v1/geocode/direcPuntoNotable ### Parameters #### Query Parameters - **departamento** (string) - Required - The department to search within. - **nombre** (string) - Required - The name of the point of interest. - **limit** (integer) - Optional - The maximum number of results to return. Defaults to 100. ### Request Example ```json { "example": "GET /api/v1/geocode/direcPuntoNotable?departamento=Cerro Largo&nombre=Correos&limit=10" } ``` ### Response #### Success Response (200) - **GeocoderResult** (array) - An array of geocoding results. #### Response Example ```json { "example": [ { "address": "Oficina de Correos Central, Cerro Largo, Uruguay" } ] } ``` ``` -------------------------------- ### GET /api/v0/geocode/SugerenciaCalleCompleta Source: https://direcciones.ide.uy/v2/api-docs Provides street suggestions based on the input text. This is useful for autocompleting address fields. Suggestions are formatted as 'street, locality, department' and ordered by the number of associated addresses. ```APIDOC ## GET /api/v0/geocode/SugerenciaCalleCompleta ### Description Retrieves street suggestions based on the provided input text. This endpoint is designed for autocompleting address fields, returning suggestions in the format 'street, locality, department', ordered by the count of associated addresses in descending order. ### Method GET ### Endpoint /api/v0/geocode/SugerenciaCalleCompleta ### Parameters #### Query Parameters - **entrada** (string) - Required - The input text to search for street suggestions. Can be a partial street name or include a door number. - **todos** (boolean) - Optional - If true, returns all matching suggestions regardless of order or count. ### Request Example ```json { "entrada": "Av. Gral. Flores", "todos": false } ``` ### Response #### Success Response (200) - **SugerenciaResultV0** (array) - A list of street suggestion results. #### Response Example ```json [ { "calle": "Av. Gral. Flores, Montevideo, Montevideo", "cantidadDirecciones": 1500 }, { "calle": "Av. Gral. Rivera, Montevideo, Montevideo", "cantidadDirecciones": 1200 } ] ``` ``` -------------------------------- ### GET /api/v1/geocode/direcPadron Source: https://direcciones.ide.uy/v2/api-docs Finds addresses by padron (property identifier) within a specified department and locality. Useful for pinpointing properties. ```APIDOC ## GET /api/v1/geocode/direcPadron ### Description Returns addresses by selecting a property (padron) within a department and locality. ### Method GET ### Endpoint /api/v1/geocode/direcPadron ### Parameters #### Query Parameters - **departamento** (string) - Required - The department to search within. - **localidad** (string) - Required - The locality to search within. - **padron** (integer) - Required - The property identifier (padron). - **limit** (integer) - Optional - The maximum number of results to return. Defaults to 100. ### Request Example ```json { "example": "GET /api/v1/geocode/direcPadron?departamento=Cerro Largo&localidad=Melo&padron=562&limit=10" } ``` ### Response #### Success Response (200) - **GeocoderResult** (array) - An array of geocoding results. #### Response Example ```json { "example": [ { "address": "Calle Principal 456, Melo, Uruguay" } ] } ``` ``` -------------------------------- ### GET /api/v0/geocode/BusquedaDireccion Source: https://direcciones.ide.uy/v2/api-docs Searches for addresses that match the specified criteria. It returns a list of addresses, including street name, door number, block, lot, locality, department, postal code, and geographic location. ```APIDOC ## GET /api/v0/geocode/BusquedaDireccion ### Description Retrieves a list of addresses matching the search criteria. Addresses include street name, door number, block, lot, locality, department, postal code, and geographic coordinates (SRID 4326). ### Method GET ### Endpoint /api/v0/geocode/BusquedaDireccion ### Parameters #### Query Parameters - **calle** (string) - Required - The street name. - **departamento** (string) - Optional - The department name. - **localidad** (string) - Optional - The locality name. ### Request Example ```json { "calle": "Avenida principal", "localidad": "Montevideo", "departamento": "Montevideo" } ``` ### Response #### Success Response (200) - **GeocoderResultV0** (array) - A list of geocoding results. #### Response Example ```json [ { "calle": "Avenida Principal", "numero": "1234", "manzana": "A", "solar": "5", "localidad": "Montevideo", "departamento": "Montevideo", "codigoPostal": "11000", "punto": { "type": "Point", "coordinates": [-56.164532, -34.901183] }, "error": "" } ] ``` ``` -------------------------------- ### GET /api/v0/geocode/BusquedaDireccion Source: https://direcciones.ide.uy/swagger-ui Retrieves a set of addresses that match the search criteria. Addresses include street name, door number, block, lot, locality, department, postal code, and geographic location. ```APIDOC ## GET /api/v0/geocode/BusquedaDireccion ### Description Retrieves a set of addresses that match the search criteria. Addresses include street name, door number, block, lot, locality, department, postal code, and geographic location (point in SRID 4326). ### Method GET ### Endpoint /api/v0/geocode/BusquedaDireccion ### Parameters #### Query Parameters - **[parameter_name]** (type) - Required/Optional - Description of the parameter ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/geocode/capasPoligonales Source: https://direcciones.ide.uy/swagger-ui Retrieves polygonal layers within the system. This service can be used in conjunction with the service to obtain addresses within a polygon. ```APIDOC ## GET /api/v1/geocode/capasPoligonales ### Description Retrieves polygonal layers within the system. This service can be used in conjunction with the service to obtain addresses within a polygon. ### Method GET ### Endpoint /api/v1/geocode/capasPoligonales ### Parameters #### Query Parameters - **[parameter_name]** (type) - Required/Optional - Description of the parameter ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Addresses in Polygon (GeoJSON) Source: https://direcciones.ide.uy/swagger-ui Receives a GeoJSON polygon in EPSG 4326 and returns the addresses contained within it. Supports filtering by type of address (portal, solar, poi). ```APIDOC ## GET /api/v1/geocode/direcEnPoligono ### Description Receives a polygon in EPSG 4326 and GeoJSON, and returns the addresses contained within that polygon. The user can specify if they want portals, lots, and/or points of interest (Parameter tipoDirec with values like portal, solar, poi). ### Method GET ### Endpoint /api/v1/geocode/direcEnPoligono ### Parameters #### Query Parameters - **polygon** (object) - Required - The GeoJSON representation of the polygon. - **tipoDirec** (string) - Optional - Specifies the type of address to return (e.g., 'portal', 'solar', 'poi'). ``` -------------------------------- ### GET /api/v1/geocode/direcEnPoligono Source: https://direcciones.ide.uy/swagger-ui Retrieves addresses contained within a specified polygon (GeoJSON format, EPSG 4326). Users can specify whether to include portals, lots, and/or points of interest via the 'tipoDirec' parameter. ```APIDOC ## GET /api/v1/geocode/direcEnPoligono ### Description Retrieves addresses contained within a specified polygon (GeoJSON format, EPSG 4326). Users can specify whether to include portals, lots, and/or points of interest via the 'tipoDirec' parameter. ### Method GET ### Endpoint /api/v1/geocode/direcEnPoligono ### Parameters #### Query Parameters - **polygon** (object) - Required - The polygon in GeoJSON format (EPSG 4326). - **tipoDirec** (string) - Optional - Type of addresses to retrieve. Possible values: 'portal', 'solar', 'poi'. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### API Buscador de Direcciones Source: https://direcciones.ide.uy/swagger-ui La API permite buscar direcciones, incluyendo calles, números de portal y puntos de interés. El servicio está alojado en direcciones.ide.uy. ```APIDOC ## API Buscador de Direcciones ### Description Este servicio puede ser utilizado para encontrar calles, calles y números de portal o puntos de interés. ### Base URL `direcciones.ide.uy/` ### Documentation [https://direcciones.ide.uy/v2/api-docs](https://direcciones.ide.uy/v2/api-docs) ### Contact Infraestructura de Datos Espaciales de Uruguay ### License GNU Affero GPL ``` -------------------------------- ### Create Locality Source: https://direcciones.ide.uy/swagger-ui Creates a new locality. This POST request retrieves the set of localities for a department, with each locality including its ID, name, postal code, and alias. ```APIDOC ## POST /api/v0/geocode/localidades ### Description POST request: The localities search service returns the set of localities for a department. Each locality is composed of its identifier, name, postal code, and alias. ### Method POST ### Endpoint /api/v0/geocode/localidades ### Parameters #### Request Body - **departamento** (string) - Required - The name of the department. - **nombre** (string) - Required - The name of the locality. - **codigoPostal** (string) - Required - The postal code of the locality. - **alias** (string) - Optional - An alias for the locality. ``` -------------------------------- ### Find Addresses Source: https://direcciones.ide.uy/swagger-ui Searches for addresses by exact match of multiple parameters. Recommended to use after autocompletion. ```APIDOC ## GET /api/v1/geocode/find ### Description Searches for addresses by exact match of multiple parameters. Use after autocompletion. ### Method GET ### Endpoint /api/v1/geocode/find ``` -------------------------------- ### Find Candidates Source: https://direcciones.ide.uy/swagger-ui Searches for address candidates. This endpoint is typically used for autocompletion features. ```APIDOC ## GET /api/v1/geocode/candidates ### Description Searches for candidates. Use for autocompletion. ### Method GET ### Endpoint /api/v1/geocode/candidates ``` -------------------------------- ### POST /api/v0/geocode/SugerenciaCalleCompleta Source: https://direcciones.ide.uy/swagger-ui Provides street suggestions based on a search query using POST. The service returns streets formatted as 'street, locality, department', ordered by the number of associated addresses. Ideal for autocompleting address fields. ```APIDOC ## POST /api/v0/geocode/SugerenciaCalleCompleta ### Description Provides street suggestions based on a search query ('entrada' parameter) using POST. The service returns streets formatted as 'street, locality, department', ordered by the number of associated addresses in descending order. Ideal for autocompleting address fields. ### Method POST ### Endpoint /api/v0/geocode/SugerenciaCalleCompleta ### Parameters #### Request Body - **entrada** (string) - Required - Free text representing an address, can be part of a street even with incomplete words (e.g., "Buenos Air") and can contain the door number. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **[field_name]** (type) - Description of the field #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### List Polygonal Layers Source: https://direcciones.ide.uy/swagger-ui Returns the polygonal layers available in the system. This service should be used in conjunction with the endpoint for retrieving addresses within a polygon. ```APIDOC ## GET /api/v1/geocode/capasPoligonales ### Description Returns the polygonal layers in the system. Use in conjunction with the service to get addresses within a polygon. Example: http://{host}:{port}/api/v1/geocode/capasPoligonales ### Method GET ### Endpoint /api/v1/geocode/capasPoligonales ### Parameters #### Query Parameters - **host** (string) - Optional - The host address. - **port** (integer) - Optional - The server port. ``` -------------------------------- ### Basic Error Controller Endpoints Source: https://direcciones.ide.uy/v2/api-docs Provides endpoints for handling errors within the application. These endpoints can be used to trigger or view error pages. ```APIDOC ## GET /error ### Description Returns an HTML page for errors. ### Method GET ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Response Example ```json { "example": "ModelAndView object representing an error page" } ``` ## HEAD /error ### Description Handles HEAD requests for error pages, typically used for retrieving headers without the body. ### Method HEAD ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Success Response (204) No Content. #### Response Example None ## POST /error ### Description Handles POST requests to the error endpoint, which can be used to trigger specific error scenarios. ### Method POST ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Success Response (201) Created. #### Response Example ```json { "example": "ModelAndView object representing an error page" } ``` ## PUT /error ### Description Handles PUT requests to the error endpoint, potentially for updating error configurations or triggering specific error states. ### Method PUT ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Success Response (201) Created. #### Response Example ```json { "example": "ModelAndView object representing an error page" } ``` ## DELETE /error ### Description Handles DELETE requests to the error endpoint, which might be used for clearing error logs or resetting error states. ### Method DELETE ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Success Response (204) No Content. #### Response Example None ## OPTIONS /error ### Description Handles OPTIONS requests for the error endpoint, providing information about the available communication options. ### Method OPTIONS ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Success Response (204) No Content. #### Response Example None ## PATCH /error ### Description Handles PATCH requests to the error endpoint, allowing for partial modifications of error-related resources or states. ### Method PATCH ### Endpoint /error ### Parameters None ### Request Example None ### Response #### Success Response (200) - **ModelAndView** - Represents a model and view for rendering error pages. #### Success Response (204) No Content. #### Response Example None ``` -------------------------------- ### GET /api/v1/geocode/findEsq Source: https://direcciones.ide.uy/swagger-ui Searches for street intersections (esquinas). Returns intersecting streets and intersection points. ```APIDOC ## GET /api/v1/geocode/findEsq ### Description Searches for street intersections (esquinas) of a given street. Returns the streets that intersect with the given street and the intersection points. ### Method GET ### Endpoint /api/v1/geocode/findEsq ### Parameters #### Query Parameters - **calle** (string) - Required - The name of the street to find intersections for. ### Response #### Success Response (200) - **intersecciones** (array) - An array of intersection details. - **calle_interseccion** (string) - The name of the intersecting street. - **punto_interseccion** (object) - The coordinates of the intersection. #### Response Example ```json { "intersecciones": [ { "calle_interseccion": "Avenida Principal", "punto_interseccion": { "lat": -34.89, "lon": -56.17 } } ] } ``` ```