Herramienta de Test de SOAP API (descargar PDF)
El presente documento constituye la descripción de usuario de la herramienta de Test de la Plataforma de Servicios Web para el acceso al almacén de datos espaciales del que dispone el Servicio de Planificación Territorial.
La aplicación de Test de la Plataforma de SOAP API se encuentra disponible en:
http://b5m.gipuzkoa.net/appws/publish.htm
Ilustración 1 Interface Web de Arranque de la Aplicación de Test de SOAP API
Pulsando el botón "Run" del interface de acceso (Ver Ilustración 1 Interface Web de Arranque de la Aplicación de Test de SOAP API) se arranca la aplicación.
Se trata de una aplicación cliente implementada con Visual Studio 2005 y lenguaje de programación C#.
2.Servicio de Consulta de callejero
2.1 Descripción
La operación buscarcallejero permite realizar diferentes tipos de consulta de diversas entidades del callejero: calles, números de portal, edificios, códigos postales, etc., en función de distintas opciones de parámetros de entrada. El nivel de detalle (información de respuesta del servicio) cambia en función del tipo de Búsqueda que se realice.
En el tab de aplicación "callejero" se accede el Interface de consulta de información del callejero. Ver imagen Ilustración 2 Interface de consulta de Callejero.
Ilustración 2 Interface de consulta de Callejero
Los distintos botones del tipo "
"ejecutan los diferentes tipo de consulta que se pueden realizar a través de este servicio. Para saber qué parámetros de entrada considera cada una de las funciones hay que pulsar los botones de interrogación adyacentes a los de consulta ("
").A continuación se describen distintas posibilidades de consulta a través de este servicio.
Pulsando el botón a la derecha del Cuadro de Texto "Código Municipio", sin poner ningún valor en los cuadros de texto, devuelve la relación completa de Municipios. El botón Interrogación resalta en otro color los campos por los que filtra la consulta y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 3 Interface de consulta de Municipio.
Se puede seleccionar un Municipio determinado introduciendo el Nombre en el Cuadro de Texto "Municipio" o bien introduciendo el Código en el Cuadro de Texto "Código de Municipio" con la opción copiar/pegar.
Pulsar el botón a la derecha del Cuadro de Texto "Código Municipio" para obtener los datos relativos a dicho Municipio. El botón Interrogación resalta en otro color los campos por los que filtra la consulta y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 4 Interface de consulta de un Municipio determinado.
Habiendo indicado un municipio y pulsando el botón a la derecha del Cuadro de Texto "Código Calle/Plaza", muestra la relación de Calles de un Municipio. El botón Interrogación resalta en otro color los campos por los que filtra la consulta y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 5 Interface de consulta de Dirección.
Se puede seleccionar una Dirección determinada introduciendo el Nombre en el Cuadro de Texto "Calle/Plaza" o bien introduciendo el Código en el Cuadro de Texto "Código Calle/Plaza" con la opción copiar/pegar.
Pulsar el botón a la derecha del Cuadro de Texto "Código Calle/Plaza" para obtener los datos relativos a dicha Dirección. El botón Interrogación resalta en otro color los campos por los que puede filtrar la consulta, y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 6 Interface de consulta de Dirección determinada.
Teniendo seleccionada una Calle y pulsando el botón a la derecha del Cuadro de Texto "Número-Bis", muestra la relación de todos los Números existentes en dicha Calle. El botón Interrogación resalta en otro color los campos por los que puede filtrar la consulta, y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 7 Interface de consulta de Número de Calle.
Se puede seleccionar un Número de Calle determinado introduciendo el Número en el Cuadro de Texto "Número".
2.1.4 Búsqueda por Nombre de Edificio
Pulsando el botón a la derecha del Cuadro de Texto "Nombre de Edificio", muestra la relación de Edificios existentes en una Calle determinada, si se ha indicado la misma, o en todo el Municipio si se ha indicado únicamente el municipio. El botón Interrogación resalta en otro color los campos por los que puede filtrar la consulta, y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 9 Interface de consulta de Nombre de Edificio.
Se puede seleccionar un Edificio determinado introduciendo el Nombre en el Cuadro de Texto "Nombre de Edificio".
Pulsar el botón a la derecha del Cuadro de Texto "Nombre de Edificio" para obtener los Edificios existentes en una Calle determinada, si se ha seleccionado previamente, o en todo el Municipio si no se ha seleccionado Calle. El botón Interrogación resalta en otro color los campos por los que filtra la consulta y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 10 Interface de consulta de Nombre de Edificio determinado.
2.1.5 Búsqueda por Código Postal
Se pueden obtener todos los Código Postales existentes en un Municipio introduciendo el Nombre o Código de Municipio y pulsando el botón a la derecha del Cuadro de Texto "Código Postal". El botón Interrogación resalta en otro color los campos por los que puede filtrar la consulta, y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 11 Interface de consulta de Código Postal.
Se pueden obtener todos los Distritos existentes en un Municipio introduciendo el Nombre o Código de Municipio y pulsando el botón a la derecha del Cuadro de Texto "Distrito". El botón Interrogación resalta en otro color los campos por los que filtra la consulta y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 12 Interface de consulta de Distrito.
Se pueden obtener todas las Secciones existentes en un Municipio y Distrito introduciendo el Nombre o Código de Municipio y el Número de Distrito.
Pulsar el botón a la derecha del Cuadro de Texto "Distrito" para obtener las distintas Secciones existentes en un Distrito. El botón Interrogación resalta en otro color los campos por los que puede filtrar la consulta, y permite hacer Búsquedas por dichos campos. Ver imagen Ilustración 13 Interface de consulta de Sección.
2.1.8 Lengua
Los valores posibles para lengua en toda la aplicación son :
3.1 Descripción
Desde el tab de aplicación "BuscarToponimia" se puede lanzar el servicio entrando valores en el Cuadro de Texto "Topónimo" y estableciendo el código de lengua en el Cuadro de Texto "Lengua". Para lanzar el servicio se pulsa el botón "Lanzar Servicio Topónimo". Ver imagen Ilustración 14 Interface de consulta de Buscar Toponimia.
Ilustración 14 Interface de consulta de Buscar Toponimia.
4.1 Operación "DibujarImagen
Esta función permite obtener una imagen cartográfica dadas dos coordenadas que definen la extensión de la misma ( MBR). Es posible especificar capas de información anadida a visualizar. Para establecer la visibilidad de las capas añadidas, se puede consultar antes las capas disponibles a través de la operación "mapasdisponibles" (Get Mapas)
Existen tres ejemplos predefinidos que muestran distintas capas ("Datos 1", "Datos 2" y "Datos 3"). Pulsando el botón "Datos2" y "Lanzar Servicio DibujarImagen" se obtiene la siguiente imagen. Ilustración 15 Interface de DibujarImagen.
4.2 Operación "Mapas disponibles"" (Gestión de capas) en el Servicio "Dibujar Imagen"
Esta operación, dado un nombre de escenario (o categoría), devuelve una lista de clases, grupos y mapas. Es la lista de mapas disponibles cuya visibilidad se puede activar en la petición de "dibujarImagen".
Ya que existe una jerarquéa de los mapas que agrupa los mapas en "Grupos" y los Grupos en "Clases", para activar una determinada capa habrá que activar también el grupo y clase a las que pertenece. Ver imagen Ilustración 16 Interface de Mapas Disponibles.
5.1 Descripción
El Servicio Web de Localizar contiene diferentes operaciones ( o funciones) que permiten realizar la localización geográfica de determinadas entidades concretas de la base de datos como son: municipios, calles, núcleos urbanos, carreteras, puntos kilométricos, topónimos, rios, o simplemente unas coordenadas xy; por poner algunos ejemplos.
Cada uno de los tabs de aplicación agrupan la posibilidad de localización de unas determinadas entidades de idiosincrasia común.
La información devuelta es la dirección URL de una imagen que incluye el elemento localizado y se visualiza en el formulario. También se devuelve cierta información alfanumórica ( de atributos ) del elemento localizado: En algunas operaciones o funciones se permite obtener, a parte de la imagen, la información de geográfica (coordenadas) del elemento consultado en determinados formatos estándar ( gml, wkb o wkt).
Es posible especificar capas de información anadida a visualizar en la imagen. Para establecer la visibilidad de las capas añadidas, se puede consultar antes las capas disponibles a través del botón "Mapas" como en el Servicio de "Dibujar Imagen".
5.2 Localizar entidades del Callejero.
En el tab "Callejero" dentro de "LocalizarObjetoPorId", se pueden seleccionar algunos identificadores de ejemplo disponibles en el desplegable "Id", o introducir el código que se desea consultar con un espacio delante.
Nota: Para los integradores de aplicaciones consumidoras del servicio, lógicamente no es necesario añadir el espacio delante del id que se localiza, solo en el este interface de la aplicación de test.
Las entidades que se pueden consultar en este caso son: Comarcas, Municipios, Núcleos Urbanos, Calles (Vector), Calles (Edificios), Distritos y Secciones, Edificios : Id, Muni_calle_portal, Actividad. Para la localización de identificadores de actividades se obtiene información de la actividad. Para el resto de las entidades, se obtiene información relativa a la dirección postal cuando corresponde.
En el botón "Lanzar Servicio" se ejecuta la petición. Ver (Ilustración 17 Ejemplo de Localización de una actividad.)
En la imagen que se obtiene aparece resaltada la entidad que se consulta o entidades relacionadas. Por ejemplo:
* En la Localización de calle se resaltan los edificios cuya dirección postal pertenece a esa calle.
* En la localización de "Distritos y Secciones" se resaltan todos los edificios pertenecientes al distrito o sección.
En el campo URL se indica la dirección dónde se encuentra la imagen generada en la petición
5.3 Localización de entidades de viales
En el tab "Viales", dentro de "LocalizarObjetoPorId", se pueden seleccionar algunos identificadores de ejemplo disponibles en el combo "Id" o introducir el código que se desea consultar con un espacio delante.
Nota Para los integradores de aplicaciones consumidoras del servicio, lógicamente no es necesario añadir el espacio delante del id que se localiza en las peticiones, solo en el este interface de la aplicación de test.
Las entidades que se pueden consultar en este caso son: Carreteras/Tren, Puntos Kilométricos, Líneas de Transporte Público y Paradas de Transporte Público.
En la Localización se obtiene una imagen que contiene la entidad localizada, información de atributos relativos a la misma, y opcionalmente un fichero xml en formato gml, wkb o wkt . En el desplegable que se encuentra a continuación del de "Id" se puede seleccionar el tipo de formato que se quiere obtener.
Se puede pedir la imagen opcionalmente en el desplegable "Imagen".
Otros parámetros que se pueden establecer en la localización son: Escala (indicando únicamente el número factor de escala), Lengua, escenario y dimensiones de la imagen a obtener.
En el botón "Lanzar Servicio" se ejecuta la petición (Ver Ilustración 18 Ejemplo de Localización a través de un identificador de parada de transporte.).
En la imagen que se obtiene aparece resaltada la entidad que se consulta o entidades relacionadas. Por ejemplo
* En la localización de puntos kilométricos se resalta también el vial.
* En la localización de línea de transporte público se resaltan también las paradas de las mismas
| Entidad | Atributos |
|---|---|
| Carreteras/Tren | Nombre, Identificador y descripción |
| Puntos Kilométricos | Nombre, Identificador y descripción de la carretera a la que pertenece. |
| Líneas de Transporte Público | Empresa, sentido, ruta, tipo y el conjunto de nombres de las paradas por las que pasa la línea de transporte. |
| Paradas de Transporte Público | Nombre de la parada e información de las líneas que pasan por esa parada con los siguientes atributos de las líneas: empresa, tipo, sentido y ruta. |
Se puede visualizar los ficheros xml de tipo gml, wkb o wkt teniendo activado el tab "Vector (Ver Ilustración 19 Ejemplo de visualización del fichero Tipo " gml" de la entidad localizada)". Ya que el tipo wkb se trata de un formato binario y no tiene sentido su visualización, se indica el no de vectores que contiene, que es un información de demuestra que se ha obtenido correctamente el fichero wkb en la petición del servicio.
En el campo URL se indica la dirección dónde se encuentra la imagen generada en la petición.
Ilustración 18 Ejemplo de Localización a través de un identificador de parada de transporte
Ilustración 18 Ejemplo de Localización a través de un identificador de parada de transporte
Ilustración 19 Ejemplo de visualización del fichero Tipo gml de la entidad localizada
5.4 Localización de entidades de Toponimia.
En el tab "Toponimia", dentro de "LocalizarObjetoPorId", se pueden seleccionar algunos identificadores de ejemplo disponibles en el combo "Id" o introducir el código que se desea consultar con un espacio delante.
Nota Para los integradores de aplicaciones consumidoras del servicio, lógicamente no es necesario añadir el espacio delante del id que se localiza en las peticiones, solo en el este interface de la aplicación de test.
Las entidades que se pueden consultar en este caso son: Barrios y Orografía.
En la Localización se obtiene una imagen que contiene la entidad localizada, información de atributos relativos a la misma, y opcionalmente un fichero xml en formato gml, wkb o wkt
Otros parámetros que se pueden establecer en la localización son: Escala (indicando únicamente el número factor de escala), Lengua, escenario y dimensiones de la imagen a obtener.
En el botón "Lanzar Servicio" se ejecuta la petición (Ver Ilustración 20 Ejemplo de Localización de un Identificador de Barrio.).
En la imagen que se obtiene aparece resaltada la entidad que se consulta o entidades relacionadas.
Los atributos que se obtienen según la entidad que se localiza son:
| Entidad | Atributos |
|---|---|
| Barrios | Información del barrio y el municipio al que pertenece |
| Orografía | Nombre, Identificador y descripción de la carretera a la que pertenece |
| Líneas de Transporte Público | Empresa, sentido, ruta, tipo y el conjunto de nombres de las paradas por las que pasa la línea de transporte. |
En el campo URL se indica la dirección dónde se encuentra la imagen generada en la petición.
Ilustración 20 Ejemplo de Localización de un Identificador de Barrio
5.5 Localización de entidades de ríos
En el tab "Rios", dentro de "LocalizarObjetoPorId", se pueden seleccionar algunos identificadores de ejemplo disponibles en el combo "Id" o introducir el código que se desea consultar con un espacio delante.
Nota Para los integradores de aplicaciones consumidoras del servicio, lógicamente no es necesario añadir el espacio delante del id que se localiza en las peticiones, sélo en el este interface de la aplicación de test.
Las entidades que se pueden consultar en este caso son: Rios y Cuencas.
En la Localización se obtiene una imagen que contiene la entidad localizada, información de atributos relativos a la misma, y opcionalmente un fichero xml en formato gml, wkb o wkt
Otros parámetros que se pueden establecer en la localización son: Escala (indicando únicamente el número factor de escala), Lengua, escenario y dimensiones de la imagen a obtener.
En el botón "Lanzar Servicio" se ejecuta la petición (Ver Ilustración 21 Ejemplo de localización una cuenca obteniendo el fichero wkt con las coordenadas de la misma.).
En la petición de localización se obtiene información del nombre e identificador del rio e de la cuenca según corresponda.
En la imagen que se obtiene aparece resaltada la entidad que se consulta o entidades relacionadas
En el campo URL se indica la dirección dónde se encuentra la imagen generada en la petición
Ilustración 21 Ejemplo de localización una cuenca obteniendo el fichero wkt con las coordenadas de la misma.
5.6 Localización de entidades de la Cartofototeca
En el tab "Toponimia", dentro de "LocalizarObjetoPorId", se pueden seleccionar algunos identificadores de ejemplo disponibles en el combo "Id" o introducir el código que se desea consultar con un espacio delante.
Nota Para los integradores de aplicaciones consumidoras del servicio, lógicamente no es necesario añadir el espacio delante del id que se localiza en las peticiones, solo en el este interface de la aplicación de test.
Las entidades que se pueden consultar en este caso son: Barrios y Orografía.
En la Localización se obtiene una imagen que contiene la entidad localizada, información de atributos relativos a la misma, y opcionalmente un fichero xml en formato gml, wkb o wkt
Otros parámetros que se pueden establecer en la localización son: Escala (indicando únicamente el número factor de escala), Lengua, escenario y dimensiones de la imagen a obtener.
En el botón "Lanzar Servicio" se ejecuta la petición (Ver Ilustración 20 Ejemplo de Localización de un Identificador de Barrio.).
En la imagen que se obtiene aparece resaltada la entidad que se consulta o entidades relacionadas.
Los atributos que se obtienen según la entidad que se localiza son:
Ilustración 22 Ejemplo de localización por Id de un elemento de la Cartofototeca.
5.7 Localización de Coordenadas XY
En el tab "XY", dentro de "LocalizarObjetoPorId", se pueden seleccionar algunos ejemplos de coordenadas XY en cualquiera de los tres sistemas contemplado. También se puede introducir las coordenadas y el sistema de coordenadas de referencia que se considera en los correspondientes Cuadros de Texto: ."Tipo", "Long" y "Lat".
En la Localización se obtiene una imagen en la que el punto geográfico localizado se encuentra en el centro de la misma y se resalta con un aspa roja (Ver ).
Otros parámetros que se pueden establecer en la localización son: Escala (indicando únicamente el número factor de escala), Lengua, escenario y dimensiones de la imagen a obtener.
En el botón "Lanzar Servicio" se ejecuta la petición.
En la petición de localización se obtienen también las coordenada consultadas en los otros dos sistemas de referencia contemplados.
En la imagen que se obtiene aparece resaltada la zona correspondiente.
En el campo URL se indica la dirección dónde se encuentra la imagen generada en la petición
Ilustración 23 Ejemplo de Localización de coordenada XY
6. Servicio ConsultarObjetoPorXY
6.1 Descripción
El Servicio Web de ConsultaObjetoPorXY contiene diferentes operaciones ( o funciones ) que permiten realizar la consulta geográfica de determinadas entidades concretas de la base de datos como son: medio físico, calles, viales, rios, o simplemente unas coordenadas xy; por poner algunos ejemplos.
6.2 Consultar Objetos de Medio Físico
Es una función que devuelve información del medio físico dado un punto geográfico, cuyas coordenadas X e Y se pasan como parámetros de entrada. Existen algunos valores de ejemplos en el desplegable "Selección".
En función de "tema" que se indique, se devuelven los correspondientes valores (Ver Ilustración 24 Interface Consultar Objeto por Medio Físico. Ejemplo de consulta del tema "VEGETACión" en unas determinadas coordenadas.
Ilustración 24 Interface Consultar Objeto por Medio Físico. Ejemplo de consulta del tema "VEGETACión" en unas determinadas coordenadas.
6.3 Consultar Objetos de Callejero
Es una función que devuelve información del callejero a partir de un punto geográfico determinado, cuyas coordenadas X e Y se pasan como parámetros de entrada. El tema "EDIFICIO". Existen algunos valores de ejemplos en el desplegable "Selección".
Ilustración 25 Interface Consultar Objeto por Callejero. Ejemplo de consulta del tema "EDIFICIO".
6.4 Consultar Objetos de Viales
Es una función que devuelve información del viales a partir de un punto geográfico determinado, cuyas coordenadas X e Y se pasan como parámetros de entrada. Existen algunos valores de ejemplos en el desplegable "Selección".
Ilustración 26 Interface Consultar Objeto por Viales
En esta función se obtienen nombres de ríos en un punto geográfico dado, cuyas coordenadas X e Y se pasan como parámetros de entrada. Existen algunos valores de ejemplos en el desplegable "Selección".
Ilustración 27 Interface Consultar Objeto por Rio
6.6 Consultar Objetos por Toponimia
En esta función se obtienen nombres de núcleos urbanos y barrios en un punto geográfico dado, cuyas coordenadas X e Y se pasan como parámetros de entrada. Existen algunos valores de ejemplos en el desplegable "Selección".
Ilustración 28 Interface Consultar Objeto por Toponimia
En esta operación o función se devuelve información del punto cuyas coordenadas X e Y se pasan como argumento. Esta información incluye datos como la Longitud y Latitud, la Altura del punto, etc. Existen algunos valores de ejemplos en el desplegable "Selección".
Ilustración 29 Interface de consulta de Buscar Objeto Por XY
6.8 Consultar Objetos de la CartoFototeca
En esta operación se obtienen datos de la cartografía existente en un punto geográfico determinado, cuyas coordenadas X e Y se pasan como argumento.
Los tipos de cartografía que se pueden consultar son: Cartografía, Cincomiles o Fotosaéreas.
Ilustración 30 Interface de consulta de Buscar Objeto por CartoFototeca
6.9 Consultar Objetos de Legislación
En esta operación se obtienen datos de una legislación relevante, dado un punto geográfico determinado
Ilustración 31 Interface de consulta de Buscar Objeto por Legislación
7.1 Descripción
El Servicio Web de Calcular Ruta devuelve las coordenadas de las polilíneas que conforman una ruta cuando existe entre los dos o tres puntos que se pasan como parámetros. La ruta se puede definir con las coordenadas de un punto inicial, un punto final y opcionalmente un punto intermedio.
7.2 Operación Consultar Coordenadas de una ruta
Dado unas coordenadas X e Y final, devuelve la ruta por carretera entre dos puntos. Opcionalmente se puede especificar un punto intermedio.
La función devuelve un XML codificado en un String con los valores XY de las líneas y vértices de la ruta.
En el tab de aplicación
Existen dos valores de ejemplos en el desplegable "Selección" que se pueden seleccionar y probar pulsando el botón "Lanzar Servicio".
En el interface se visualizan las coordenadas de las polilíneas de las ruta que devuelve el servicio ( Ver Ilustración 32 Ejemplo de consulta de un ruta entre dos puntos.)
Ilustración 32 Ejemplo de consulta de un ruta entre dos puntos.
