Geoportal Resources Access API Reference

The Geoportal Resources Access Library provides functions to simply handle geoportal web services usage.

Usage pattern : For each web service usage, invoque the corresponding function and get response data with onSuccess callback param.

Example :

Gp.Services.getConfig({
    apiKey : "e4iu7ff4ot440oj40byfkciw",
    onSuccess : function(response) {
        // response is a Gp.Services.GetConfigResponse object
        ...
    }
}) ;

Geoportal access key management

Access to Geoportal resources metadata availables with one ore several keys, using the Geoportal Configuration project.

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.getConfig()	Gp.Services.GetConfigResponse

Elevation web service usage

Getting elevations in or along of one or several points on french territories using the elevation services of the Geoportal Platform.

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.getAltitude()	Gp.Services.AltiResponse

Geocoding web service usage

Getting positon of a geographic identifier (places names, address, cadastral parcel, other...) using the geocoding web service of the Geoportal Platform.

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.geocode()	Gp.Services.GeocodeResponse

Reverse Geocoding web service usage

Retrieving geographical identifiers (place names, address, cadastral parcels, ...) near a given position, using the reverse geocoding web service of the Geoportal Platform.

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.reverseGeocode()	Gp.Services.GeocodeResponse

Autocompletion web service usage

Getting suggestions of probable places names or address based on uncomplete texts, using the autocompletion service of the Geoportal Platform

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.autoComplete()	Gp.Services.AutoCompleteResponse

Routing web service usage

Getting a route from one point to another using the route service of the Geoportal Platform.

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.route()	Gp.Services.RouteResponse

IsoCurve web service usage

Computing a set of places (curve) reachable from a given point (or from where to start to reach a given point) within a time or distance constraint using isucurve service of the Geoportal Platform.

Function to invoque	Response Object (onSuccess callback param)
Gp.Services.isoCurve()	Gp.Services.IsoCurveResponse

Index