Web 1:5000 - Gipuzkoa Provincial Council

Geographic Search Engine:

SOAP API Technical Documentation

SOAP API Technical Documentation (PDF download)

• 1. Introduction
• 2. Generic Description of the SOAP API
• 3. Service Test
  • 3.1 Test in Web Environment
  • 3.2 Test using the Test Application
• 4. "Consulta de Callejero" (Consult Street Gazetteer) SOAP API
  • 4.1 "buscarcallejero" (search Street Gazetteer) Operation
    • 4.1.1 Functional description
    • 4.1.2 Input parameters
    • 4.1.3 Output parameters
      • 4.1.3.1 Output data structure
      • 4.1.3.2 Description of the output parameters
    • 4.1.4 Example Code
• 5. "Buscar Toponimo" (Search for Toponymy) SOAP API"
  • 5.1 "Toponimo" (Toponymy) Operation
    • 5.1.1 Input parameters
    • 5.1.2 Output parameters
      • 5.1.2.1 Description of the output parameters
    • 5.1.3 Example Code
• 6. "dibujarimagenmbr" (Draw Image MBR) Operation
  • 6.1 "Dibujar Imagen" (Draw Image) SOAP API
    • 6.1.1 Input parameters
    • 6.1.2 Output parameters
  • 6.2 Example Code
  • 6.3 "Mapas Disponibles" (Available Maps) Operation
    • 6.3.1 Input parameters
    • 6.3.2 Output parameters
• 7. "Localizar" (Locate) SOAP API
  • 7.1 Locate Street Gazetteer Entities
    • 7.1.1 Input parameters
    • 7.1.2 Output parameters
  • 7.2 Entities Location of the Cartography Survey Inventory
    • 7.2.1 Input parameters
    • 7.2.2 Output parameters
  • 7.3 Locate river entities
    • 7.3.1 Input parameters
    • 7.3.2 Output parameters
  • 7.4 Locate Toponyms
    • 7.4.1 Input parameters
    • 7.4.2 Output parameters
  • 7.5 Locate Roadways
    • 7.5.1 Input parameters
    • 7.5.2 Output parameters
  • 7.6 Locate XY Coordinates
    • 7.6.1 Input parameters
    • 7.6.2 Output parameters
  • 7.7 Example Code
• 8. "Consultar" (Consult) SOAP API
  • 8.1 Consult Coordinates Operation
    • 8.1.1 Input parameters.
    • 8.1.2 Output parameters.
  • 8.2 Consult Toponymy Operation
    • 8.2.1 Input parameters.
    • 8.2.2 Output parameters.
  • 8.3 Consult Roadway Operation
    • 8.3.1 Input parameters.
    • 8.3.2 Output parameters.
  • 8.4 Consult Street Gazetteer Operation
    • 8.4.1 Input parameters.
    • 8.4.2 Output parameters
  • 8.5 Consult Rivers Operation
    • 8.5.1 Input parameters.
    • 8.5.2 Output parameters.
  • 8.6 Consult Map Library Operation
    • 8.6.1 Input parameters.
    • 8.6.2 Output parameters.
  • 8.7 Example Code.
• 9. Calcular Ruta (Routing)
  • 9.1 Consult Routing Coordinates Operation
    • 9.1.1 Input parameters.
    • 9.1.2 Output parameters.
  • 9.2 Example Code.

1. Introduction

This document is the technical description of the SOAP API Platform developed to promote access to the Spatial Data Infrastructure of Gipuzkoa Provincial Council. The documentation is aimed at integrating "consumer" solutions of the SOAP API, which are currently available in the platform. It is the interface and functional description and lists the input and output parameters of each of the functions.

This document is the technical description of the SOAP API Platform developed to promote access to the Spatial Data Infrastructure of Gipuzkoa Provincial Council. The documentation is aimed at integrating "consumer" solutions of the SOAP API, which are currently available in the platform. It is the interface and functional description and lists the input and output parameters of each of the functions.

The services have been implemented according to the SOAP (Simple Object Access Protocol) and WSDL.

• The SOAP standard defines the mechanism through which calls are made to the services and response information is obtained. The SOAP clients invoke services by sending items in XML format using the HTTP protocol.
• The WSDL standard (SOAP API Definition Lenguaje) describes the external interface of a Service, in order for the developers to be able to create clients capable of using it based on that definition.

The implementation of a services platform based on those standards enables client and service applications to communicate and understand each other by means of a variety of platforms and different development languages provided that they meet the following requirements:

• Interoperability: An application that uses any of the services does not have to know the software or hardware platform on which this service runs. A service can be accessed by different client types (such as web applications, wireless applications or other services), while the technological standard service is used.
• Encapsulation: An application that uses a service component does not need to worry about the internal details of its programming.

For generic information about the standard, we recommend the following documentation by Sun Microsystems, Inc:
http://java.sun.com/developer/technicalArticles/WebServices/soa2/WSProtocols.html#soatechs

Return to Index

2 Generic Description of the SOAP API

The SOAP API platform has a series of Services that each one, one or more possible operations (functions). Each of them are described in this document.

Each one of the Services has a web page called "SOAP API Home Page" (See Illustration I Example of SOAP API Home Page ), which provides access to the WSDL file, to the test page or "Editor Page", JavaScript interface documentation, and the list of available operations or functions for the service.

The WSDL (SOAP API Descriptor Language) is an XML file that mainly indicates the format to be used in the conformation of a request to the service and the meaning of the request. It can be saved locally.

The test page allows a request to be invoked to some of the service functions by entering the relevant input parameters in a web interface.

The developed services are set below, with a generic description of their functionality and the addresses of their relevant "Home Page".

1 Callejero (Street Gazetteer)

• It receives names of municipalities, streets, etc and returns information about municipalities, streets, gateways, buildings, localization coordinates, etc.
• http://b5m.gipuzkoa.net/ws/dfg-callejero-context-root/CallejeroSoapHttpPort

2 Toponimia (Toponymy)

• Given a name, it returns all the place names of buildings, streets, rivers, etc? which coincide with it and their localization coordinates.
• http://b5m.gipuzkoa.net/ws/dfg-toponimo-context-root/ToponimoSoapHttpPort

3 Dibujar (Draw)

• It receives two coordinates that mark a window and returns an image.
• http://b5m.gipuzkoa.net/ws/dfg-dibujar-context-root/DibujarSoapHttpPort

4 Localizar (Localize)

• Given an item identifier, it returns its attributes and a localization image of the element.
• http://b5m.gipuzkoa.net/ws/dfg-dibujar-context-root/DibujarSoapHttpPort

5 Consultar (Consult).

• It receives an XY and a topic name and returns the attributes of the topic item located in that coordinates.
• http://b5m.gipuzkoa.net/ws/dfg-consultar-context-root/ConsultarPorCoordenadasSoapHttpPort

6 Calcular Ruta (Calculate Route)

• It receives two or more coordinates and returns a route (without turning restrictions and therefore not valid for vehicles).
• http://b5m.gipuzkoa.net/ws/dfg-calculo_rutas/CalculoRutaSoapHttpPort

Illustration I Example of SOAP API Home Page Search by Coordinates Service

Return to Index

3 Service Test

3.1 Test in Web Environment

The Test page is accessed the Editor´s Page by clicking on the service operation to be tested ( see Illustration 2 Access to the Editor´s Page from the home page of the Place Name Service by clicking "buscartoponimo" (search place name) operation.

Illustration 2 Access to the Editor´s Page from the home page of the Place Name Service by clicking "buscartoponimo" (Search Place Name) operation

This page can be used to test different input parameters for the service, since a table is displayed that sets out the different parameters or items, their data types and text boxes to introduce possible values. If the parameter is optional according to the service definition, a check box appears before the parameter.

• Select the check box if the parameter is to be included in the test
• Clear the check box if no value is to be included in the optional parameter.
• Click "Preview SOAP" to view the SOAP request for the operations with established parameters and the test page is accessed (See Illustration 3 Service Operation Test Run Page.) By clicking Invoke, the petition is performed and the response XML is displayed.

Illustration 3 Service Operation Test Run Page

Return to Index

3.2 Test using the Test Application

3.2 Test using the Test Application

The SOAP API Platform test application is currently available at:

http://b5m.gipuzkoa.net/appws/publish.htm

The application is started up by clicking the Run button of the access interface (See Illustration 4 SOAP API Test Application Run Interface).

This application package is an implemented example of Microsoft .Net technology that allows calls to be made to all SOAP API, view the results, whether they are images or alphanumerical data, displayed in application formulas.

It includes directly selectionable example data in order to be able to quickly execute set examples, without having to search for valid entry parameter cases.

This application package allows the Service to be rapidly tested using valid input data, as well as being an example solution.

Illustration 4 SOAP API Test Application Run Interface

Note: SOAP API Test Application Run Interface

Return to Index

4. "Consulta de Callejero" (Consult Street Gazetteer) SOAP API

4.1 "buscarcallejero" (search Street Gazetteer) Operation

4.1.1 Functional description

The buscarcallejero (search street gazetteer) operation is the only one in this service. It allows the user to perform different types of street searches: municipalities, streets, door numbers, buildings, post codes, etc.; according to the different input parameter options. The level of detail (service response information) changes according to the type of search performed.

Table 1 Input Parameters required by Search Type indicates the parameters required in the call to the service, for each of the search types that can be performed with this service.

As a municipality can be specified by its name or code, and a street likewise by its name or code, even though both are checked in the table, the service can be invoked with either of the two fields. If the "muni" (municipality) field contains data, it should be remembered that the service does not use the "codmuni" (municipality code) field. If the "calle" (street) field contains data, the service likewise does not use the "codcalle" (street code) field.

Table 1 Input Parameters required by Search Type

Example interpretation of the table: A Street type search filters the response according to the muni or codmuni, calle or codcalle, codpostal, distrito and seccion fields.

A municipality must be chosen for the Number and Building type searches.

Search Type

	Municipality	Street	Number	Building	Post Code	District	Section
Municipality	x	x	x	x	x	x	x
codmuni	x	x	x	x	x	x	x
Street	-	x	x	x	x	x	x
codcalle	-	x	x	x	x	x	x
Number	-	-	x	x	-	x	x
bis	-	-	x	x	-	x	x
nomedif	-	-	x	x	-	-	-
codpostal	x	x	-	x	x	-	-
District	-	x	x	x	x	x	x
Section	-	x	x	x	x	x	x

Return to Index

4.1.2 Input parameters

The following tables sets out the input parameters of the street plan SOAP API.

Input parameters of the street plan SOAP API

Name	Type	Example values
Type	String	The different search types in the table may any of the following: Municipality, Street, Number, Building, CP, District or Section
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
Municipality	String	Name of the Municipality, for example: Donostia
codmuni	String	Eustat code for the Municipality, for example: 004
Street	String	Name of the street, for example: aldakoenea
codcalle	String	Eustat code for the Street, for example: 1200
Number	String	Door number, for example: 010
bis	String	Bis, for example A or empty
nomedif	String	The name of the building, for example: etxeberria
codpostal	String	Post Code: 001
District	String	District: 04
Section	String	Section : 002

Return to Index

4.1.3 Output parameters

4.1.3 Output parameters

Table 2 Output Parameters Returned by Search Type indicates the fields returned by the SOAP API according to the search type.

Table 2 Output Parameters Returned by Search Type

Search Type

	Municipality	Street	Number	Building	Post Code	District	Section
Municipality	x	x	x	x	-	x	x
codmuni	x	x	x	x	-	x	x
Street	-	x	x	x	-	-	-
codcalle	-	x	x	x	-	-	-
Number	-	-	x	x	-	-	-
bis	-	-	x	x	-	-	-
nomedif	-	-	x	x	-	-	-
codpostal	-	-	x	x	x	-	-
District	-	-	x	x	-	x	x
Section	-	-	x	x	-	-	x
XEd50utm	x	x	x	x	-	-	-
YEd50utm	x	x	x	x	-	-	-
ZEd50	x	x	x	x	-	-	-
lonEd50	x	x	x	x	-	-	-
latEd50	x	x	x	x	-	-	-
lonWgs84	x	x	x	x	-	-	-
latWgs84	x	x	x	x	-	-	-
cod3d	x	x	x	x	-	-	-
x1Ed50utm	x	x	x	x	-	-	-
y1Ed50utm	x	x	x	x	-	-	-
x2Ed50utm	x	x	x	x	-	-	-
y2Ed50utm	x	x	x	x	-	-	-
urlInfo	x	x	x	x	-	-	-
url2d	x	x	x	x	-	-	-
urlOrto	x	x	x	x	-	-	-
url3d	x	x	x	x	-	-	x
urlGoogle	x	x	x	x	x	-	-

4.1.3.1 Output data structure

Table 2 Output Parameters Returned by Search Type

Name	Type	Example values
return	WsreplyUser
objectOut	Array de WscallobjUser

Name	Type	Example values
wsmessage	String
wsstatus	Decimal

"WscallobjUser" in an output data type with the following parameters:

WscallobjUser parameters

Name	Type	Example values
Municipality	String	ALBIZTUR
codmuni	String	004
Street	String	ALBIZTUR NUCLEO
codcalle	String	1110
Number	String	045
bis	String	A
nomedif	String	ARKATZPE
codpostal	String	20495
District	String	01
	String	001
XEd50utm	Decimal	570729
YEd50utm	Decimal	4775742
ZEd50	Decimal	259
lonEd50	Decimal	-2.13045033281384
latEd50	Decimal	43.1303388591911
lonWgs84	Decimal	-2.13169361178994
latWgs84	Decimal	43.12923609425
cod3d	Decimal	259
x1Ed50utm	Decimal	570716.956
y1Ed50utm	Decimal	4775735.155
x2Ed50utm	Decimal	570733.538
y2Ed50utm	Decimal	4775750.224
urlInfo	String	http://b5m.gipuzkoa.net/kaletegia/url?key=K_040_1608&lengua=0
url2d	String	http://b5m.gipuzkoa.net/url5000/index.php?id=K_040_1608……
urlOrto	String	http://b5m.gipuzkoa.net/url5000/index.php?id=K_040_1608……
url3d	String	http://b5m.gipuzkoa.net/gipuzkoa3D/Gipuzkoa3D/ReDist/LurbiraRotAround Pt.htm?583009,4790785,42
urlGoogle	String	http://maps.google.com/maps?q=43.26452520………

Example: Building Type, codmuni=004, Bis=A.

4.1.3.2 Description of the output parameters

Description of the output parameters

Type	Description
Municipality	Municipality Name
codmuni	Municipality Code
Street	Street Name
codcalle	Street Code
Number	Door number
bis	Bis
nomedificio	Name of the building
codpostal	Post Code
District	District
Section	Section
XEd50utm	X coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
YEd50utm	Y coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
ZEd50	Height (ED50 UTM 30 North) of the centre of the MBR of the items
lonEd50	Longitude (ED50) of the centre of the MBR of the items
latEd50	Latitude (ED50) of the centre of the MBR of the items
lonWgs84	Longitude (WGS84) of the centre of the MBR of the items
latWgs84	Latitude (WGS84) of the centre of the MBR of the items
cod3d	Virtual height (ED50 UTM 30 North) of the centre of the MBR of the items for the Gipuzkoa 3D virtual flight
x1Ed50utm	Minimum X coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
y1Ed50utm	MinimumY coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
x2Ed50utm	Maximum X coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
y2Ed50utm	Maximum Y coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
urlInfo	Links the "5m" web application. It is the URL direction where more information can be found on the 1:5000 web site
url2d	Links the "b5m" web application. It is a URL type link to the 1:5000 website that displays the search result with a map type background configuration.
urlOrto	Links the "b5m" web application. It is a URL type link to the "b5m" website that displays the search result with an orthophoto type background image configuration.
url3d	It is a URL type link to the "b5m" website that runs the Gipuzkoa 3D virtual flight in the geographical position set in the search.
urlGoogle	It is a Google Maps link (URL address) where the zone set in the search is displayed.

Return to Index

4.1.4 Example Code

The following C# example (for Visual Studio 2005) shows how to call the SOAP API with a "Street" search type and codimuni=004 and calle=SANTA parameters, which returns one record.

To register the SOAP API and create proxies, the following steps must be implemented:

• 1. Select "Add Web Reference" from the "Solution Explorer" window.
• 2. In the window that appears, put the WSDL path in the URL field and the ws_Callejero text in the "Web Reference Name" field and select "Add Reference"
• 3. Visual Studio automatically generates the C# proxies and the relevant DataSource.
• 4. In order to automatically create a DataGridView which is linked to the DataSource, the toponimoarrOut object can be dragged from the "Data Sources" window to a form.

private ws_Callejero.Callejero webCall;
-----------------------------------------------

// Limpiar los resultados anteriores.
callejeroBindingSource.Clear();
Refresh();

// Crear instancia del servicio web.
webCall = news ws_Callejero.Callejero;

// Llamar al Web Service
ws_Callejero.CallejeroUser_buscarcallejero_Out t webCallMuniOut = webCall.buscarcallejero ("0","Calle","","004","SANTA","","","","","",","");

// Si ha funcionado y nos ha devuelto algo, pasar los datos al DataSource
if (webCallMuniOut.@return.wsstatus == -1)
        MessageBox.Show(webCallMuniOut.@return.wsmessage);
else
                if ((Convert.ToInt16(webCallMuniOut.@return.wsstatus)) >0)
                        callejeroBindingSource.DataSource = webCallMuniOut.objectOut;

--------------------------------------------------

Return to Index

5. "Buscar Toponimo" (Search for Toponymy) SOAP API"

5.1 "Toponimo" (Toponymy) Operation

5.1.1 Input parameters

The toponimo operation allows all the database items coinciding with a given text to be searched. Given a name, it returns all the toponyms (place names) of buildings, streets, rivers, etc? which coincide with it, together with their localization coordinates.

Entry parameters:

Input parameters

Name	Type	Values
toponimo	String	Toponymy string to be searched. Examples: "victor" or "customs 13 irun"
language	String	0.Spanish (add language) 1.Basque 2.English 3.French

Return to Index

5.1.2 Output parameters

Outgoing parameters:

Name	Type	Values
return	Decimal	Number of records returned
toponimoarrOut	Array de WstopobjUser

"WstopobjUser" is a type of output data with the following values:

Table 3 Example for the input parameters: toponimo=victor, lengua=0 (place name=victor, language=0)

Name	Type	Example values
Name	String	VICTOR HUGO KALEA
Type	String	CALLE
otro	String	HERNANI
codigo	String	K_040_1608
direccion	String
XEd50UTM	Decimal	583009
YEd50UTM	Decimal	4790785
ZEd50	Decimal	42
lonEd50	Decimal	-1.9772408737149
latEd50	Decimal	43.2645252048455
lonWgs84	Decimal	-1.97848413231404
latWgs84	Decimal	43.2634269038068
cod3d	Decimal	42
x1Ed50UTM	Decimal	582990.936
y1Ed50UTM	Decimal	4790750.12
x2Ed50UTM	Decimal	583052.8
y2Ed50UTM	Decimal	4790803.1984
urlInfo	String	http://b5m.gipuzkoa.net/kaletegia/url?key=K_040_1608lengua=0
url2d	String	http://b5m.gipuzkoa.net/url5000/index.php?id=K_040_1608
urlOrto	String	http://b5m.gipuzkoa.net/url5000/index.php?id=K_040_1608
url3d	String	http://b5m.gipuzkoa.net/gipuzkoa3D/Gipuzkoa3D/ReDist/LurbiraRotAroundPt.htm?583009,4790785,42
urlGoogle	String	http://maps.google.com/?q=43.2634269038,-1.978

5.1.2.1 Description of the output parametersa

Description of the output parameters

Type	Description
nombre	The name of the item found that contains the keyword searched by the user.
tipo	The type of name in question, for example, EDIFICIO (BUILDING), MUNICIPIO (MUNICIPALITY), BARRIO (DISTRICT), ARROYO (STREAM), CALLE (STREET), DIRECCION POSTAL (POSTAL ADDRESS), etc.
otro	Municipality, basin or other information
codigo	It is the item code in the database[1]
direccion	Post address where applicable.
XEd50UTM	X coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
YEd50UTM	Y coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
ZEd50	Height (ED50 UTM 30 North) of the centre of the MBR of the items
lonEd50	Longitude (ED50) of the centre of the MBR of the items
latEd50	Latitude (ED50) of the centre of the MBR of the items
lonWgs84	Longitude (WGS84) of the centre of the MBR of the items
latWgs84	Latitude (WGS84) of the centre of the MBR of the items
cod3d	Virtual height (ED50 UTM 30 North) of the centre of the MBR of the items for the Gipuzkoa 3D virtual flight
x1Ed50UTM	Minimum X coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
y1Ed50UTM	Minimum y coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
x2Ed50UTM>	Maximum X coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
y2Ed50UTM	Maximum y coordinate (ED50 UTM 30 North) of the centre of the MBR of the items
urlInfo	Links the "b5m" web application. It is the URL direction where more information can be found on the 1:500 web site
url2d	Links the "b5m" web application. It is a URL type link to the 1:5000 website that displays the search result with a map type background configuration.
urlOrto	Links the "b5m" web application. It is a URL type link to the "b5m" website that displays the search result with an orthophoto type background image configuration.
url3d	It is a URL type link to the "b5m" website that runs the Gipuzkoa 3D virtual flight in the geographical position set in the search.
urlGoogle	It is a Google Maps link (URL address) where the zone set in the search is displayed.

[1]The warehousing ítems code can be used for other SOAP API, such as "LocalizarporId".

Return to Index

5. "Buscar Toponimo" (Search for Toponymy) SOAP API"

5.1.3 Example Code

The following C# example (for Visual Studio 2005) shows how to call the SOAP API with parameters toponimo=victor and lengua=0, which returns 16 STREET and BUILDING records.

N.B.To discover how to register the SOAP API, see the Callejero example.

private ws_BuscarTopo.Toponimo webTop;
-----------------------------------------------

// Limpiar los resultados anteriores.
toponimoarrOutBindingSource.Clear();
Refresh();

// Crear instancia del servicio web.
webTop = new ws_BuscarTopo.Toponimo();

// Llamar al Web Service
ws_BuscarTopo.ToponimoUser_buscartoponimo_Out webTopOut = webTop.buscartoponimo; ("victor","0" );

// Escribir el número de registros devueltos en la ventana.
TxtRegistros.Text = Convert.ToString(webTopOut.@return);

// Si ha funcionado y nos ha devuelto algo, pasar los datos al DataSource
if ((Convert.ToInt16(TxtRegistros.Text)) > 0)
      toponimoarrOutBindingSource.DataSource = webTopOut.toponimoarrOut;

--------------------------------------------------

Return to Index

6. "dibujarimagenmbr" (Draw Image MBR) Operation

6.1 "Dibujar Imagen" (Draw Image) SOAP API

This function is used to obtain an orthophoto or map type image based on two coordinates that define the extension of the map (MBR). It returns the Minimum Bounding Rectangle of the resulting image, as well as its URL. Additional information layers to be viewed can be specified. In order to establish the visibility of the added topics, the available topics can be consulted using the mapasdisponibles (available maps) operation (see following point).

6.1.1 Input parameters

Entry parameters:

Name	Type	Values
ix1	String	Minimum X, e.g. 540000
iy1	String	Minimum Y, e.g. 4740000
ix2	String	Maximum X, e.g. 610000
iy2	String	Maximum Y, e.g. 4810000
iwidth	String	Width in pixel, e.g. 600
iheight	String	Height in pixel, e.g. 400
iescenario	String	Scenario, e.g.: PUBLI
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
mapaselectarr	WsmapasselectUser Array

"WsmapasselectUser" is an item of the following type:

Name	Type	Example values
Name	String	pharmacies
status	String	yes
Type	String	Class, Group, Map

An example to include the displaying of pharmacies would be:

Name	status	Type
Invisible	yes	Class
Invisible	yes	Group
pharmacies	yes	Map

As there is a hierarchy of the maps that orders the maps in "Groups" and the Groups in "Classes", the group and class to which it belongs will have to be activated in order to activate a specific layer. To know which topics are available for a given scenario, call mapasdisponibles described in the following point.

6.1.2 Output parameters

Output data structure:

	Type	Example values
return	String
oimagepathOut	String	Returns the path of the generated image: http://b5m.gipuzkoa.net/internet/GenaImageSourcer?IMAGEID=2677484727 &RETCONTENTTYPE=image/png&RM=FALSE
x1	String	X minimum of the generated image
y1	String	Y minimum of the generated image
x2	String	X maixmum of the generated image
y2	String	Y maximum of the generated image

Return to Index

6.2 Example Code

The following C# example (for Visual Studio 2005) shows how to call the SOAP API with the following parameters:

• ix1=540000
• iy1=4740000
• ix2=610000
• iy2=4810000
• iwidth=629
• iheight=362
• iescenario=PUBLI
• lengua=0
• mapaselectarr=null

The SOAP API generates the image and returns its URL.

N.B. To discover how to register the SOAP API, see the Callejero example.

private ws_BibImagen.Dibujar();
-----------------------------------------------

// Crear instancia del servicio Web.
webDibImg = new ws_DibImagen.Dibujar();
Refresh();

// Array para la selección de mapas.
ws_DibImagen.WsmapasselectUser[] nomArr = null;

// Llamar al Web Service
ws_DibImagen.DibujarUser_dibujarimagen_Out webDibImgOut =
webDibImg.dibujarimagen ("540000","4740000","610000","4810000","629","362","PUBLI","0", nomArr);

// Dibujar la imagen en un PictureBox.
PictureBox1.ImageLocation = webDibImgOut.oimagepathOut;

--------------------------------------------------

Return to Index

6.3 "Mapas Disponibles" (Available Maps) Operation

This operation, given as scenario (or category), displays a list of classes, groups and maps. It therefore returns the list of available topics, whose viewing can be activated using the "dibujarimagen" request.

Entry parameters:

Entry parameters:

Name	Type	Values
categoría	String	Scenario, e.g.: PUBLI
language	String	0.Spanish (add language) 1.Basque 2.English 3.French

Outgoing parameters:

Output data structure:

Name	Type	Example values
WsreplyUser	String
WsmapasUser	WsmapasUser array

"WsreplyUser" is a data type with the following parameters:

Name	Type	Example values
wsmessage	String
wsstatus	Decimal

"WsreplyUser" is a data type with the following parameters:

Name	Type	Example values
Class	String	Actividades (Activities)
grupo (group)	String	Turismo(Tourism)
mapa (map)	String	T_19
descripcion (description)	String	Playas (Beaches)
MActivado	String	n
GActivado	String	n
CActivado	String	n

Return to Index

7. "Localizar" (Locate) SOAP API

The "Localizar" (Locate) SOAP API contains different operations (or functions) that can be used to provide the geographical location of specific entities from the database, such as: municipalities, streets, urban centres, roads, kilometric points, place names, rivers, or just xy coordinates, to give just some examples.

Each one of the application tabs offers the possibility to locate specific entities with a common idiosyncrasy.

The information returned is the address of an image that includes the locate item (URL), alphanumerical information about the located item, and in some operations or functions, geographical information (coordinates) about the searched item can be obtained, using the image, in certain standard formats (gml, wkb or wkt).

Additional information layers to be viewed can be specified. In order to establish the visibility of the added topics, the available topics can be consulted using the mapasdisponibles operation from the Dibujar Imagen service.

In order to discover the codes of the entities to be located, the buscarcallejero operation of the Consulta del Callejero (Search Street Gazetteer) SOAP API and the toponimo operation of the Search Toponymy SOAP API can be used.

7.1 Locate Street Gazetteer Entities

After identification data is entered in any of the entities in question, it returns attributes and there is the option of a map in raster or vectorial format.
Operation name: localizaridcallejero

7.1.1 Input parameters

Entry parameters:

Name	Type	Values
identificador(identifier)	String	Identifier: code of the entity to be located Examples: Region. S_3 Municipality: M_045 Urban Centre: N_30145 Street (roadway): V_003_1110 Street (buildings): K_003_1110 Statistical Districts and Sections: SC_045_01_003 Postal Address: D_4545 Buildings : E_51507 Muni_calle_portal(municipality_street_door): F_045_1110_003 Activity: A_11933
escala(scale)	String
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
imagen(image)	String	Image: yes/no
escenario(scenario)	String	Scenario.Example: PUBLI
anchura	String	Width in pixels of the generated image. Example: 800
altura	String	Height in pixels of the generated image. Example: 600
vector	String	GML, WKT, WKB
mapaselectarr	WsmapasselectUser

"WsmapasselectUser" is an input data type with the following parameters:

Name	Type	Example values
Name	String	pharmacies
status	String	yes
Type	String	Class, Group, Map

As there is a hierarchy of the maps that orders the maps in "Grupos" (Groups) and the Groups in "Clases" (Classes), the group and class to which it belongs will have to be activated in order to activate a specific layer. To know which topics are available for a given setting, call mapasdisponibles described in the following point.

7.1.2 Output parameters

Alphanumerical information of the entity to be located and an image is obtained, together with the option of the gml, wkb or wkt files.

Outgoing parameters:

Name	Type	Example values
return	String
imagenurlOut	String	http://b5m.gipuzkoa.net/internet/GenaImageSourcer
objectOut	TipocallejerosUser

"TipocallejerosUser"is a data type with the following parameters:

Name	Type	Example values
listaDirecciones	DireccionPostalUser Array.
listaActividades	ActividadUser Array

Example : E_51507

"DireccionPostalUser" is a data type with the following parameters:

Name	Type	Example values
seccion	String	003
nucleoUrbano	String
codigoPostal	String	20004
nombre	String
numero	String	004
terminoMunicipal	String
distrito	String	02
municipio	String	DONOSTIA-SAN SEBASTIAN
comarca	String
Street	String	REPUBLICA ARGENTINA
Amunicipio	String	069
Acalle	String	3970
wktVec	String
wkbVec	base64Binary
gmlVec	String

"ActividadUser" is a data type with the following parameters:

Name	Type	Example values
tipoActividad	String	MONUMENTO
nombreActividad	String	Maria Cristina
ATipoActividad	String	F.1.1
a2NombreActividad	String	23255
a1NombreActividad	String	69241

Return to Index

7.2 Entities Location of the Cartography Survey Inventory

After a cartography survey identifier is entered, it returns attributes and there is the option of a map in raster format. Operation name: localizaridcartofototeca

7.2.1 Input parameters

Entry parameters:

Name	Type	Values
identificador(identifier)	String	Survey code to be located Examples: Q_002, Q_001_6429a1a.dwg
escala	String
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
imagen(image)	String	Image: yes/no
escenario(scenario)	String	Scenario.Example: PUBLI
anchura (width)	String	Width in pixels of the generated image. Example : 800
altura(height)	String	Height in pixels of the generated image Example : 600
vector	String	GML, WKT, WKB
mapaselectarr	WsmapasselectUser

7.2.2 Output parameters

Outgoing parameters:

Name	Type	Values
return	String
imagenurlOut	String	http://b5m.gipuzkoa.net/internet/GenaImageSourcer
objectOut	CartoUser

"CartoUser" is a data type with the following parameters

Name	Type	Values
Cartofototeca	TipocartofototecaUser

Example : Q_002

"TipocartofototecaUser" is a data type with the following parameters:

Name	Type	Values
propietario (owner)	String	AYTO. de LEZO
lugar (place)	String	LEZO
Scale	String	1000
empresa (company)	String	NEURRI ingenieros S.A.
fichero	String
fechaLevantamientoOriginal (Original Survey Date)	String	01-06-1974
fechaUltimaActualizacion (Last Update Date)	String	01-07-1998
fechaDigitalizacion(Digitalization Date)	String	01-07-1998

Return to Index

7.3 Locate river entities

After a river or basin identifier is entered, it returns attributes and there is the option of a map in raster and vector format.
Name: localizaridrios

7.3.1 Input parameters

Entry parameters:

Name	Type	Values
identificador(identifier)	String	Identifier: code of the entity to be located Examples : Basin: C_11 River: I_16072
escala	String	Scale. Example: 5000 or empty
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
imagen(image)	String	Image: yes/no
escenario(scenario)	String	Scenario.Example: PUBLI
anchura (width)	String	Width in pixels of the generated image. Example : 800
altura(height)	String	Height in pixels of the generated image Example : 600
vector	String	GML, WKT, WKB
mapaselectarr	WsmapasselectUser

7.3.2 Output parameters

Alphanumerical information (attributes) of the entity to be located and an image is obtained, together with the option of the gml, wkb or wkt files.

Outgoing parameters:

Name	Type	Values
return	String
imagenurlOut	String	http://b5m.gipuzkoa.net/internet/GenaImageSourcer
objectOut	TiporioUser

"TiporioUser" is a data type with the following parameters:

Name	Type	Example values
rio (river)	String	UROLA
cuenca (basin)	String	rioUROLA
ARio	String	12
ACuenca	String	16072
wktVec	base64Binary
wkbVec	String
gmlVec	String

Example : I_16072

Return to Index

7.4 Locate Toponyms

After an orography or neighbourhood identifier is entered, it returns attributes and there is the option of a map in raster and vector format. Operation name: localizaridtoponimia

7.4.1 Input parameters

Entry parameters:

Name	Type	Values
identificador(identifier)	String	Identifier: code of the entity to be located Examples : Districts (name): Z_13363 Districts (area): B_12402 Districts (combined): B_12402_13363 Orography (name): G_24071 Orography (area): O_19171 Orography (combined): O_19171_21539
escala	String	Scale. Example: 5000 or empty
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
imagen(image)	String	Image: yes/no
escenario(scenario)	String	Scenario.Example: PUBLI
anchura (width)	String	Width in pixels of the generated image. Example : 800
altura(height)	String	Height in pixels of the generated image Example : 600
vector	String	GML, WKT, WKB
mapaselectarr	WsmapasselectUser

7.4.2 Output parameters

Outgoing parameters:

Name	Type	Values
return	String
imagenurlOut	String	http://b5m.gipuzkoa.net/internet/GenaImageSourcer
objectOut	TipotopoUser

"TipotopoUser" is a data type with the following parameters:

Name	Type	Example values
municipio	String	URNIETA
barrio(district)	String
orografia(orography)	String	MONTE ABALLARRI
AMunicipio	String
AOrografia	String	24071
wktVec	String
wkbVec	base64Binary
gmlVec	String

Example : G_24071

Return to Index

7.5 Locate Roadways

After a roadway, kilometric point, transport line or stop identifier (which are not updated), it returns attributes with the option of a raster and vector format. Name: localizaridviales

7.5.1 Input parameters

Entry parameters:

Name	Type	Values
identificador(identifier)	String	Identifier: code of the entity to be located Examples : Roads/Train: T_9044 Kilometric Points: T_9044_1.4 Public Transport Lines: TP_155 Public Transport Stops: RA_176
escala	String	Scale. Example: 5000 or empty
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
imagen(image)	String	Image: yes/no
escenario(scenario)	String	Scenario.Example: PUBLI
anchura (width)	String	Width in pixels of the generated image. Example : 800
altura(height)	String	Height in pixels of the generated image Example : 600
vector	String	GML, WKT, WKB
mapaselectarr	WsmapasselectUser

7.5.2 Output parameters

Alphanumerical information (attributes) of the entity to be located and an image is obtained, together with the option of the gml, wkb or wkt files.

Outgoing parameters:

Name	Type	Values
return	String
imagenurlOut	String	http://b5m.gipuzkoa.net/internet/GenaImageSourcer
objectOut	TipovialesUser

"TipovialesUser" is a data type with the following parameters:

Name	Type	Example values
carretera (road)	String	carretera (road) GI-3162
descripcion(description)	String	Al barrio de Urdaneta (Aia)
ACarretera	String	9044
wktVec	String
wkbVec	base64Binary
gmlVec	String
lineasTransporte(Transport lines)	TipolineaUser
paradasTransporte(Transport stops)	TipoparadaUser

Example : T_9044

"TipolineaUser" is a data type with the following parameters:

Name	Type	Example values
empresa (company)	String	(RENFE)
type (tipo)	String	L?NEA DE TREN (TRAIN LINE)
sentido (direction)	String	IDA (OUTWARD)
ruta (route)	String	IRUN-BRINKOLA
paradas (stops)	ParadaUser Array

"TipoparadaUser" is a data type with the following parameters:

Name	Type	Example values
nombre	String	ELOSEGI ALKATEA,3 AURREAN (DONOSTIA)
paradas (stops)	ParadaUser Array

Example : RA_176

"TipolineasUser" is a data type with the following parameters:

Name	Type	Example values
empresa	String	HIJOS A. AREIZAGA
type (tipo)	String	l?nea de autobus interurbano
sentido (direction)	String	IDA (OUTWARD)
ruta (route)	String	A3-PASAI SAN PEDRO-DONOSTIA/SAN SEBASTIAN

Return to Index

7.6 Locate XY Coordinates

After XY values and projection type are entered, it returns values in UTM30 and Lat-Long and there is an option of a map in raster format. Name: localizaridxy

7.6.1 Input parameters

Entry parameters:

Name	Type	Values
x	String	Coordinate
y	String	Coordinate
type (tipo)	String	UTM, Lat/Long , Lat/Long-WGS84
escala	String	Scale. Example: 5000 or empty
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
imagen(image)	String	Image: yes/no
escenario(scenario)	String	Scenario.Example: PUBLI
anchura (width)	String	Width in pixels of the generated image. Example : 800
altura(height)	String	Height in pixels of the generated image Example : 600
mapaselectarr	WsmapasselectUser

7.6.2 Output parameters

Outgoing parameters:

Name	Type	Example values
return	String
imagenurlOut	String	http://b5m.gipuzkoa.net/internet/GenaImageSourcer
objectOut	TipoxyUser

"TipoxyUser" is a data type with the following parameters:

Name	Type	Example values
XUtm	String	582573
YUtm	String	4797250
lat	String	-1 58 53.8
lon	String	43 19 22
latW	String	-1 58 58.4
lonW	String	43 19 18

Example: tipo = Lat/Long, x= -1 58 53.87 , y= 43 19 22.

Return to Index

7.7 Example Code

The following C# example (for Visual Studio 2005) shows how to call the LocalizarPorId-Callejero SOAP API with the following parameters:

• identificador(identifier)= A_11933
• escala(scale)=
• language=0
• imagen(image)=si
• escenario(scenario)=PUBLI
• anchura (width)=447
• altura(height)=307
• vector=GML
• mapaselectarr=null

The SOAP API returns a record in the Activities DataSource and another in the Addresses DataSource.

N.B.To discover how to register the SOAP API, see the Callejero example.

private ws_Localizar.LocalizarPorId webId;
-----------------------------------------------

// Limpiar los resultados anteriores.
listaActividadesBindingSource.Clear();
listaDireccionesBindingSource.Clear();
Refresh();

// Array para la selección de mapas.
ws_Localizar.WsmapasselectUser[] nomArr = null;

// Crear instancia del servicio Web.
webId = new ws_Localizar.LocalizarPorId();

// Llamar al Web Service
ws_Localizar.LocalizarPorIdUser_localizaridcallejero_Out webIdOut =
webId.localizaridcallejero("A_11933","","0","si","PUBLI","447","307","GML",nomArr);

/ Si ha funcionado y nos ha devuelto algo, pasar los datos al DataSource
if (webIdOut.objectOut.listaActividades != null)
     listaActividadesBindingSource.DataSource = webIdOut.objectOut.listaActividades;

/ Si ha funcionado y nos ha devuelto algo, pasar los datos al DataSource
if (webIdOut.objectOut.listaDirecciones != null)
     listaDireccionesBindingSource.DataSource = webIdOut.objectOut.listaDirecciones;

--------------------------------------------------

Return to Index

8. "Consultar" (Consult) SOAP API

The Consultar (Consult) SOAP API returns information on the elements of a specific entity that are in specific geographical coordinates. Both the name of the search entity and the X and Y coordinates are sent as input parameters.

8.1 Consult Coordinates Operation

This operation or function returns information from the point, whose X and Y coordinates become the input parameters. This information includes data such as Longitude and Latitude, the height of the point, etc. Operation name: consultarcoorcoordenadas

8.1.1 Input parameters.

Entry parameters:

Name	Type	Values
tema	String	COORDENADAS(COORDINATES)
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
coorX	String	X en ED50 UTM30N Ejem. 581082
coorY	String	Y en ED50 UTM30N Ejem. 4793752

8.1.2 Output parameters.

Outgoing parameters:

Name	Type	Example values
return	String
objectOut	TipocoordenadaUser

"TipocoordenadaUser" is a data type with the following parameters:

Name	Type	Example values
pendiente(slope)	String	20-30 % (lidar: 5-10 %)
orientacion(aspect)	String	ESTE(EAST)
ed50	Tipoed50User
wgs84	Tipowgs84User

Tipoed50User es un tipo de dato con el siguiente parámetros:

Name	Type	Example values
longitudGeograficas	String	-2 0 1.9
latitudGeograficas	String	43 17 29.2
alturaGeograficas	String	67m
XUtm30	String	581082 m
YUtm30	String	4793752 m
alturaUtm30	String	67 m (lidar=76 m)

"Tipowgs84User" is a data type with the following parameters:

Name	Type	Example values
longitudGeograficas	String	-2 0 6.5
latitudGeograficas	String	43 17 25.2
alturaGeograficas	String	117m
XGeocentricas	String	4647142 m
YGeocentricas	String	-162430 m
ZGeocentricas	String	4351116 m

Return to Index

8.2 Consult Toponymy Operation

8.2 Consult Toponymy Operation

This operation or function of the search service provides information on the region, municipality, district and orography of the geographical point whose x and y coordinates become input parameters. Operation name: consultarcoortoponimia

8.2.1 Input parameters.

Entry parameters:

Name	Type	Values
tema	String	TOPONIMIA(TOPONYMY)
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
coorX	String	X en ED50 UTM30N Ejem. 583269
coorY	String	Y en ED50 UTM30N Ejem. 4797499

8.2.2 Output parameters.

Outgoing parameters:

Name	Type	Example values
return	String
objectOut	TipotoponimiaUser

"TipotoponimiaUser" is a data type with the following parameters:

Name	Type	Example values
barrio(district)	String	GROS
nombreUrbano(urban name)	String	GROS
nucleoUrbano(urban centre)	String	DONOSTIA-SAN SEBASTIAN
terminoMunicipal(municipality)	String	DONOSTIA-SAN SEBASTIAN
comarca(area)	String	DONOSTIALDEA
ABarrio	String	14524
ANombreUrbano	String	14524
ANucleoUrbano	String	13996
ATerminoMunicipal	String
AComarca	String

Return to Index

8.3 Consult Roadway Operation

It is a function that returns a name or names of streets, roads or railways from a given geographical point, whose X and Y coordinates become the input parameters. Operation name: consultarcoorvial

8.3.1 Input parameters.

Entry parameters:

Name	Type	Values
tema	String	VIAL (ROADWAY)
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
coorX	String	X in ED50 UTM30N E.g. 583515
coorY	String	Y in ED50 UTM30N E.g. 4795662

8.3.2 Output parameters.

Outgoing parameters:

Name	Type	Example values
return	String
objectOut	TipovialUse

"TipovialUse" is a data type with the following parameters:

Name	Type	Example values
calle(street)	String	GREGORIO ORDOÑEZ
carretera (road)	String
carreteraDesc	String
municipio(municipality)	String	DONOSTIA-SAN SEBASTIAN
ACalle	String	7920
ACarretera	String
AMunicipio	String	069

Return to Index

8.4 Consult Street Gazetteer Operation

It is a function that returns street gazetteer information from a given geographical point, whose X and Y coordinates become the input parameters. Operation name: consultarcoorcallejero

8.4.1 Input parameters.

Entry parameters:

Name	Type	Values
tema	String	MUNICIPIO, EDIFICIO, CALLE(MUNICIPALITY, BUILDING, STREET)
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
coorX	String	X in ED50 UTM30N E.g. 582583
coorY	String	Y in ED50 UTM30N E.g. 4797168

8.4.2 Output parameters

Outgoing parameters:

Name	Type	Example values
return	String
objectOut	TipocallejeroUser

"TipocallejeroUser" is a data type with the following parameters:

Name	Type	Example values
listaDirecciones	DirPostalUser Array
listaActividades	ActividadUser Array	Used when the topic=EDIFICIO (BUILDING)

"DirPostalUser" is a data type with the following parameters:

Name	Type	Example values
seccion (statistical section)	String	003
nucleoUrbano(urban centre)	String
codigoPostal(postal code)	String	20004
nombre (name)	String
matricula(code)	String	PT2782AN
numero(number)	String	004
idPostal	String	D_41247
terminoMunicipal(municipality)	String
idArea	String	E_51507
distrito	String	02
municipio(municipality)	String	DONOSTIA-SAN SEBASTIAN
comarca(area)	String
calle(street)	String	REPUBLICA ARGENTINA
AMunicipio	String	069
ACalle	String	3970

Example: tema=EDIFICIO, x=582793, y= 4797268

"ActividadUser"" is a data type with the following parameters:

Name	Type	Example values
nombreActividad(activity name)	String	MONUMENTO(MONUMENT)
nombreActividad(activity name)	String	Maria Cristina
ATipoActividad	String	F.1.1
a2NombreActividad	String	23255
a1NombreActividad	String	69241

Return to Index

8.5 Consult Rivers Operation

It is a function that returns river names from a given geographical point, whose XY coordinates become the input parameters. Name: consultarcoorrio

8.5.1 Input parameters.

Entry parameters:

Name	Type	Values
tema	String	RIO(RIVER)
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
coorX	String	X in ED50 UTM30N E.g. 582868
coorY	String	Y in ED50 UTM30N E.g. 4797335

8.5.2 Output parameters.

Outgoing parameters:

Name	Type	Example values
return	String
objectOut	TiporioUser

"TiporioUser" is a data type with the following parameters:

Name	Type	Example values
rio(river)		rio URUMEA
cuenca(basin)		URUMEA
ARio		16436
ACuenca		13

Return to Index

8.6 Consult Map Library Operation

This operation returns data from the map library on a specific geographical point, whose X and Y coordinates become the argument. The cartography types that can be searched are: CARTOGRAF?A (CARTOGRAPHY), CINCOMILES (1:5000) o FOTOSAEREAS (AERIAL PHOTOS). Name: consultarcoorcartofototeca

8.6.1 Input parameters.

Entry parameters:

Name	Type	Values
tema	String	CARTOGRAFIA, CINCOMILES,FOTOSAEREAS (CARTOGRAPHY, 1:5000, AERIAL PHOTOS)
language	String	0.Spanish (add language) 1.Basque 2.English 3.French
coorX	String	X in ED50 UTM30N E.g. 581082
coorY	String	Y in ED50 UTM30N E.g. 4793752

8.6.2 Output parameters.

Outgoing parameters:

Name	Type	Example values
fotosAereas	TipofotosareaUser Array.	tema= FOTOSAEREAS(topic=AERIAL PHOTOS)
cincoMiles	TipocincomilUser aRRAY.	tema=CINCOMILES(topic= 1:5000)
cartografia	TipocartofototecaUser Array.	tema=CARTOGRAFIA(topic=CARTOGRAPHY)

"TipofotosareaUser" is a data type with the following parameters:

Name	Type	Example values
pasada(flight strip)	String	06a
fotograma(frame)	String	6374
link	String	http://b5m.gipuzkoa.net...
type (tipo)	String	April/May - 1:15000 - flight complete - negatives and slides
ano(year)	String	2001

Example : tema= FOTOSAEREAS, x=581082, y=4793752

"TipocincomilUser" is a data type with the following parameters:

Name	Type	Example values
fecha(date)	String	1983
enlace(link	String	http://b5m.gipuzkoa.net...

Example : tema=CINCOMILES, x=573993, y=4781593

"TipocartofototecaUser" is a data type with the following parameters:

Name	Type	Example values
propietario(owner)	String	AYUNTAMIENTO(MUNICIPALITY COUNCIL.)
lugar(place)	String	DONOSTIA
escala(scale)	String	500
empresa (company)	String	VARIOS(VARIOUS)
fichero	String	N12_2.DWG
fechaLevantamientoOriginal (Original Survey Date)	String	01-05-2001
fechaUltimaActualizacion (Last Update Date)	String	01-10-2003
fechaDigitalizacion(Digitalization Date)	String	01-05-2001

Example : tema= CARTOGRAFIA, x= 581082, y=4793752

Return to Index

8.7 Example Code.

The following C# example (for Visual Studio 2005) shows how to call the Consult River SOAP API with the following parameters:

• tema=RIO
• lengua=0
• coorX=582868
• coorY=4797335

N.B.To discover how to register the SOAP API, see the Callejero example.

private ws_Consultar.ConsultarPorCoordenadas webId;
-------------------------------------------

// Limpiar los resultados anteriores.

consultarPorCoordenadasUser_consultarcoorrio_OutBindingSource.Clear();
Refresh();

// Crear instancia del servicio Web.

webXY = new ws_Consultar.ConsultarPorCoordenadas();

// Llamar al Web Service.

ws_Consultar.ConsultarPorCoordenadasUser_consultarcoorrio_Out webXYOut
= webXY.consultarcoorrio("RIO","0","582868","4797335");

// Si ha funcionado, pasar los datos al DataSource

if (webXYOut.@return == "OK")
consultarPorCoordenadasUser_consultarcoorrio_OutBindingSource.DataSource
= webXYOut.objectOut;
-------------------------------------------

Return to Index

9. Calcular Ruta (Routing)

9.1 Consult Routing Coordinates Operation

Given a XY initial and a final xy, it returns the road route between two points. An intermediary point may optionally be specified. Name: calcularruta

9.1.1 Input parameters.

Entry parameters:

Name	Type	Values
ix0	String	Source X coordinate, E.g. 550497
iy0	String	Source Y coordinate, E.g. 4790307
ix1	String	X Coordinate of an intermediate point
iy1	String	Y Coordinate of an intermediate point
ixd	String	Destination X coordinate E.g. 549665
iyd	String	Destination Y coordinate E.g. 4789587

9.1.2 Output parameters.

The function returns an XML codified in a String with the XY values of the route line and vertices.
Example:

• <genaServerReply>
• <text type="stdout">
• <resultados>
• <line>548652.49 4786818.13 548652.49 4786824.27 548653.36 4786833.78 </line>
• <line>548786.36 4787388.04 548759.05 4787374.01 548706.17 4…………</line>
• <line> 548744.29 4786605.94 548736.21 4786610.33 548725.42 ………</line>
• </resultados>
• </text>
• <status value="0"/>
• </genaServerReply>

Return to Index

9.2 Example Code.

The following C# example (for Visual Studio 2005) shows how to call the Calculate Routing SOAP API with the following parameters:

• ix0=550497
• iy0=4790307
• ix1=
• iy1=
• ixd=549665
• iyd=4789587

The SOAP API returns an XML in a String that can be read in C# with the XmlTextReader.

N.B.To discover how to register the SOAP API, see the Callejero example.

private ws_Ruta.CalculoRuta webId;
-----------------------------------------------

// Limpiar los resultados anteriores.
lsbCalcRutaOut.Items.Clear();
Refresh();

// Crear instancia del servicio web.
webRuta = new ws_Ruta.CalculoRuta();

// Llamar al Web Service
string sXML = Convert.ToString(webRuta.calcularruta(
                 "550497","4790307","","","549665","4789587"));

--------------------------------------------------

Return to Index