Web Services - API


Overview

The NuMaps mapping service (Nuserv) API encapsulates an OGC1 compliant Web Map
Service (WMS) and enhances it with numaps own request extensions. These requests and
associated responses can form the basis for encapsulating Numaps
DemographicDrapes™ into your own mapping applications.
 
Underlying the Nuserv service are OGC compliant Cubeserv™ servers, from Cubewerx
Inc. The “nuserv.cfm” web service simply acts as a secure gateway (proxy) to these
services.   
 
With the Numaps mapping service you can:
 

  • Make standard OGC WMS requests and receive appropriate responses. For example a getMap request or a getCapabilities request.
  • Make NuMaps specific requests to obtain available drape lists and other information about your available DemographicDrapes™.  
  •  Make requests designed for securing your application (and your account) with our services.
       

Connecting to the service

With the NuMaps service all requests are made through one base URL. For Testing purposes you can utilise 
http://test.numaps.com.au/nuserv.cfm to connect to our service.

Please note: We offer no SLA on this service and sometimes this URL may not be available. Contact us if you have connection problems.

OGC WMS requests

All Standard OGC WMS requests are supported, however NuMaps users will, by default, have only access to the following under the NuMaps “nuserv.cfm” service. Requests are made in the form of 

http://test.ws.numaps.com.au/nuserv.cfm?request=requestname&option1=value&option2=...

Request Descritpion returns try
getCapabilities Displays server information and layers available OGC compliant XML document go
getMap Obtain an image Map

An image in the form of a gif, jpeg or png file*.

go
getlegendgraphic Obtains a legend for any of the  DemoGraphic Drapes™ you request

An image in the form of a gif, jpeg or png file

go

* Other image formats (eg SVG) may work but are not supported. Contact us if you need special image format functionality.


Example 1 - getCapabilities request

http://staging.numaps.com.au/nuserv.cfm?request=getcapabilities

Example 2 - getMap request

http://test.numaps.com.au/nuserv.cfm?
FORMAT=image/gif&VERSION=1.1.3&QUALITY=BEST&TRANSPARENT=true&SERVICE=WMS&RE
QUEST=GetMap&STYLES=default&EXCEPTIONS=application/vnd.ogc.se_inimage&SRS=EPSG:4326
&BBOX=137.8125,-36.5625,140.625,-33.75&WIDTH=512&HEIGHT=512


For further information on utilising OGC WMS requests and responses please visit 
http://www.opengeospatial.org/standards/wms  

Should you require access to other OGC WMS requests please contact NuMaps to discuss your requirements.

OGC WFS requests

All Standard OGC WFS requests are supported, however NuMaps users will, by default, have only access to the following under the NuMaps “nuserv.cfm” service. Requests are made in the form of 

http://test.ws.numaps.com.au/nuserv.cfm?Request=requestname&option1=value&option2=...

Request Descritpion Returns
getFeature The GetFeature operation allows retrieval of features information for an area, point or group of areas


OGC compliant XML document

Can be html or plain text based on input depending on request paramaters.

getFeatureType This method returns the feature geometries type (i.e., point, line or polygon features) in a layer
describeFeatureType The function of the DescribeFeatureType operation is to generate a schema description of feature types
getFeatureInfo

GetFeatureInfo provides feature information by identifying a point on a map based on its pixel location

For further information on utilising OGC WFS requests and responses please visit 
http://www.opengeospatial.org/standards/wfs  

Should you require access to other OGC WFS requests please contact NuMaps to discuss your requirements.

NuMaps Extended Requests

NuMaps offers some simple extended requests which follow the same model as an OGC formatted request but offers greater funcationality for the Web Mashup user and for testing DemographicDrapes™ availability.

As with other request types these actions area available under the NuMaps “nuserv.cfm” service and are identified by the requestname starting with "numa". Requests are made in the form of 

http://test.ws.numaps.com.au/nuserv.cfm?Request=numaRequestName&option1=value&option2=...

Request Description Return Format Optional Parameters Try
numaDrapeTest Displays a list of test maps for the demographicDrapes™ you have available HTML - go
numaGetDrapeList Obtain a list of drapes you have access to with metadata. Much like a getcapabilities request but much simplier. XML document or JSON format Format=JSON or XML go
numaGetSLD Obtains a NuMaps SLD (Style Layer Descriptor) file associated with a drape. You need to know the drapeID you are accessing. Drape Ids can be obtained from a numaDrapeTest request. XML Style Layer Descriptor drapeID=n

go

Security requests We have a number of required protective security requests for subscribers. These are not published here but will be supplied when you join. 
Polygon boundary requests Available to those who subscribe to our polygon service. Made available to those customers seperately