Table of Contents

Introduction..........................................................................................................................................3
Who should read this?......................................................................................................................3
What can I do with this?..................................................................................................................3
SOAP 1.1 Protocol specifications....................................................................................................3
PointsOfInterest Web Service...............................................................................................................4
SaveLocation...................................................................................................................................4
Description..................................................................................................................................4
Parameters...................................................................................................................................4
Request format............................................................................................................................4
HTTP Headers........................................................................................................................4
HTTP XML Content...............................................................................................................4
Typical Request......................................................................................................................4
Typical Response....................................................................................................................5
RemoveLocation..............................................................................................................................5
Description..................................................................................................................................5
Parameters...................................................................................................................................5
Request format............................................................................................................................5
HTTP Headers........................................................................................................................5
HTTP XML Content...............................................................................................................6
Typical Request......................................................................................................................6
Typical Response....................................................................................................................6
GetLocations....................................................................................................................................6
Description..................................................................................................................................6
Parameters...................................................................................................................................6
Request format............................................................................................................................7
HTTP Headers........................................................................................................................7
HTTP XML Content...............................................................................................................7
Typical Request......................................................................................................................7
Typical Response....................................................................................................................7
SaveCategory...................................................................................................................................8
Description..................................................................................................................................8
Parameters...................................................................................................................................8
Request format............................................................................................................................8
HTTP Headers........................................................................................................................8
HTTP XML Content...............................................................................................................8
Typical Request......................................................................................................................8
Typical Response....................................................................................................................9
RemoveCategory.............................................................................................................................9
Description..................................................................................................................................9
Parameters...................................................................................................................................9
Request format............................................................................................................................9
HTTP Headers........................................................................................................................9
HTTP XML Content...............................................................................................................9
Typical Request....................................................................................................................10
Typical Response..................................................................................................................10
GetCategories.................................................................................................................................10
Description................................................................................................................................10
Parameters.................................................................................................................................10
Request format..........................................................................................................................10
HTTP Headers......................................................................................................................10
HTTP XML Content.............................................................................................................10
Typical Request....................................................................................................................11
Typical Response..................................................................................................................11
Introduction
This document covers the specification of the GpsGate Server SOAP POI Web Service API.

Who should read this?

Developers aiming to build applications which need to manage POIs in GpsGate Server.

What can I do with this?

Manage Points of interest. Create, remove, edit.

SOAP 1.1 Protocol specifications

This API is fully based on SOAP protocol.
See: http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
PointsOfInterest Web Service
URL: http://localhost/GpsGateServer/Services/PointsOfInterest.asmx

SaveLocation
Description
Add or update an existing POI. Set iLocationID to 0 to create a new POI.
The <editable> tag in the response can be ignored.

Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D57A1A6DFA5 ID of the session from Yes
386EC4 Login response. Used to
authenticate and
authorize the request.
iApplicationID int 12 ID of application. Yes
iLocationID long 4 ID of POI. Yes
dblLatitude double 10 Latitude. Yes
dblLongitude double 20 Longitude. Yes
strName string Restaurant #1 The name of the POI. Yes
strDescription string Additional details... Description. Yes
iCategoryID int 47 ID of POI category. Yes

Request format

HTTP Headers
POST /GGS/Services/GpsGate.PointsOfInterest.Service/soap/PointsOfInterest.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/SaveLocation"

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SaveLocation xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
<iApplicationID>int</iApplicationID>
<iLocationID>long</iLocationID>
<dblLatitude>double</dblLatitude>
<dblLongitude>double</dblLongitude>
<strName>string</strName>
<strDescription>string</strDescription>
<iCategoryID>int</iCategoryID>
</SaveLocation>
</soap:Body>
</soap:Envelope>

Typical Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SaveLocation xmlns="http://gpsgate.com/services/">
<strSessionID>01D7CAB6BCEE2D8885D4D752F0A76F2B</strSessionID>
<iApplicationID>114</iApplicationID>
<iLocationID>4</iLocationID>
<dblLatitude>10</dblLatitude>
<dblLongitude>10</dblLongitude>
<strName>l</strName>
<strDescription>l...</strDescription>
<iCategoryID>47</iCategoryID>
</SaveLocation>
</soap:Body>
</soap:Envelope>

Typical Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SaveLocationResponse xmlns="http://gpsgate.com/services/">
<SaveLocationResult>
<result xmlns="">
<id>4</id>
<pos>
<lng>10</lng>
<lat>10</lat>
<alt>0</alt>
</pos>
<pointOfInterest>l</pointOfInterest>
<description>l...</description>
<categoryId>47</categoryId>
<editable>false</editable>
</result>
</SaveLocationResult>
</SaveLocationResponse>
</soap:Body>
</soap:Envelope>

RemoveLocation
Description
Remove a POI.

Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D57A1A6DFA5 ID of the session from Yes
386EC4 Login response. Used to
authenticate and
authorize the request.
iApplicationID int 12 ID of application. Yes
iLocationID long 4 ID of POI. Yes

Request format

HTTP Headers
POST /GGS/Services/GpsGate.PointsOfInterest.Service/soap/PointsOfInterest.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/RemoveLocation"

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveLocation xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
<iApplicationID>int</iApplicationID>
<iLocationID>long</iLocationID>
</RemoveLocation>
</soap:Body>
</soap:Envelope>

Typical Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveLocation xmlns="http://gpsgate.com/services/">
<strSessionID>01D7CAB6BCEE2D8885D4D752F0A76F2B</strSessionID>
<iApplicationID>114</iApplicationID>
<iLocationID>4</iLocationID>
</RemoveLocation>
</soap:Body>
</soap:Envelope>

Typical Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveLocationResponse xmlns="http://gpsgate.com/services/">
<RemoveLocationResult>
<OK xmlns="">OK</OK>
</RemoveLocationResult>
</RemoveLocationResponse>
</soap:Body>
</soap:Envelope>

GetLocations
Description
Get all POIs in the specified category.
The <editable> tag in the response can be ignored.

Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D57A1A6DFA5 ID of the session from Yes
386EC4 Login response. Used to
authenticate and
authorize the request.
iApplicationID int 12 ID of application. Yes
iCategoryID int 47 ID of POI category. Yes
Request format

HTTP Headers
POST /GGS/Services/GpsGate.PointsOfInterest.Service/soap/PointsOfInterest.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/GetLocations"

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLocations xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
<iApplicationID>int</iApplicationID>
<iCategoryID>int</iCategoryID>
</GetLocations>
</soap:Body>
</soap:Envelope>

Typical Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLocations xmlns="http://gpsgate.com/services/">
<strSessionID>01D7CAB6BCEE2D8885D4D752F0A76F2B</strSessionID>
<iApplicationID>114</iApplicationID>
<iCategoryID>47</iCategoryID>
</GetLocations>
</soap:Body>
</soap:Envelope>

Typical Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetLocationsResponse xmlns="http://gpsgate.com/services/">
<GetLocationsResult>
<result xmlns="">
<LocationBag>
<id>4</id>
<pos>
<lng>10</lng>
<lat>10</lat>
<alt>0</alt>
</pos>
<pointOfInterest>l</pointOfInterest>
<description>l...</description>
<categoryId>47</categoryId>
<editable>false</editable>
</LocationBag>
</result>
</GetLocationsResult>
</GetLocationsResponse>
 </soap:Body>
</soap:Envelope>

SaveCategory
Description
Add or update an existing POI category. Set iCategoryID to 0 to create a new category.
The <editable> and <editableLocations> tags in the response can be ignored.

Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D57A1A6DFA5 ID of the session from Yes
386EC4 Login response. Used to
authenticate and
authorize the request.
iApplicationID int 12 ID of application. Yes
iCategoryID int 47 ID of POI category. Yes
strCategoryName string Restaurants Category name. Yes

Request format

HTTP Headers
POST /GGS/Services/GpsGate.PointsOfInterest.Service/soap/PointsOfInterest.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/SaveCategory"

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SaveCategory xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
<iApplicationID>int</iApplicationID>
<iCategoryID>int</iCategoryID>
<strCategoryName>string</strCategoryName>
</SaveCategory>
</soap:Body>
</soap:Envelope>

Typical Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SaveCategory xmlns="http://gpsgate.com/services/">
<strSessionID>01D7CAB6BCEE2D8885D4D752F0A76F2B</strSessionID>
<iApplicationID>114</iApplicationID>
<iCategoryID>0</iCategoryID>
<strCategoryName>lcw</strCategoryName>
</SaveCategory>
</soap:Body>
</soap:Envelope>
Typical Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SaveCategoryResponse xmlns="http://gpsgate.com/services/">
<SaveCategoryResult>
<result xmlns="">
<id>47</id>
<name>lcw</name>
<minZoom>3</minZoom>
<maxZoom>0</maxZoom>
<iconSrc />
<iconSrcActive />
<editable>false</editable>
<editableLocations>false</editableLocations>
</result>
</SaveCategoryResult>
</SaveCategoryResponse>
</soap:Body>
</soap:Envelope>

RemoveCategory
Description
Remove a POI category.

Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D57A1A6DFA5 ID of the session from Yes
386EC4 Login response. Used to
authenticate and
authorize the request.
iApplicationID int 12 ID of application. Yes
iCategoryID int 46 ID of POI category. Yes

Request format

HTTP Headers
POST /GGS/Services/GpsGate.PointsOfInterest.Service/soap/PointsOfInterest.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/RemoveCategory"

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveCategory xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
<iApplicationID>int</iApplicationID>
<iCategoryID>int</iCategoryID>
</RemoveCategory>
</soap:Body>
</soap:Envelope>
Typical Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveCategory xmlns="http://gpsgate.com/services/">
<strSessionID>01D7CAB6BCEE2D8885D4D752F0A76F2B</strSessionID>
<iApplicationID>114</iApplicationID>
<iCategoryID>46</iCategoryID>
</RemoveCategory>
</soap:Body>
</soap:Envelope>

Typical Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveCategoryResponse xmlns="http://gpsgate.com/services/">
<RemoveCategoryResult>
<OK xmlns="">OK</OK>
</RemoveCategoryResult>
</RemoveCategoryResponse>
</soap:Body>
</soap:Envelope>

GetCategories
Description
Get all POI categories in the specified application.
The <editable> and <editableLocations> tags in the response can be ignored.

Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D57A1A6DFA5 ID of the session from Yes
386EC4 Login response. Used to
authenticate and
authorize the request.
iApplicationID int 12 ID of application. Yes

Request format

HTTP Headers
POST /GGS/Services/GpsGate.PointsOfInterest.Service/soap/PointsOfInterest.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/GetCategories"

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetCategories xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
 <iApplicationID>int</iApplicationID>
</GetCategories>
</soap:Body>
</soap:Envelope>

Typical Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetCategories xmlns="http://gpsgate.com/services/">
<strSessionID>01D7CAB6BCEE2D8885D4D752F0A76F2B</strSessionID>
<iApplicationID>114</iApplicationID>
</GetCategories>
</soap:Body>
</soap:Envelope>

Typical Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetCategoriesResponse xmlns="http://gpsgate.com/services/">
<GetCategoriesResult>
<result xmlns="">
<LocationCategoryBag>
<id>46</id>
<name>lcw</name>
<minZoom>3</minZoom>
<maxZoom>0</maxZoom>
<iconSrc />
<iconSrcActive />
<editable>true</editable>
<editableLocations>true</editableLocations>
</LocationCategoryBag>
</result>
</GetCategoriesResult>
</GetCategoriesResponse>
</soap:Body>
</soap:Envelope>