Documentation Center

Viz World User Guide

Version 17.0 | Published March 11, 2019 ©

Browsing Regions

Viz World Server allows browsing regions (e.g. administration levels country, admin1, admin2) by returning a feed that represents each region and contains entries for each sub-region (or if none, entries representing towns in that region).

Each entry contains an atom description of the region, a link to its feed, links to towns contained in that region, a link to a map of the region (using the Place Finder functionality shown later) and an XML representation that is used by the Viz World clients.

URLs

The below URL is the main URL that returns a feed of all countries.

http://<vizworldserver>:10301/Browse

The below URL is an example region URL that returns a feed containing an entry for each sub-region of the queried region. If no sub-regions exist, a list of towns in that region will be returned.

http://<vizworldserver>:10301/Browse?id=91296a0a00000600

Parameters

The following describes the main fields (XML tags) of each entry:

  • Id: Viz World database unique id of the region/town.

  • Title: Viz World database name of the region/town.

  • Summary: http text containing feature details - thumbnail, feature type, name, link to map (using Place Finder URL), link to major/minor/both towns of the region (if exists).

  • Content: Contains an xml representation of the feature, containing information like long/lat, full region description (i.e. “Paris France” for Paris), feature type and more information that the querying application might need.

  • Link (down): Contains the same link as the link (alternate). Required by Viz FeedBrowser.

    images/download/attachments/29301922/rest_browse-regions.png

    The summary (depicted above) is displayed in browsers like this (circled in red). For more details, see the XML Example below.

Example

<entry>
<id>1000000000001200</id>
<title type="text">Belgium</title>
<summary type="html">&lt;table&gt;&lt;tr&gt;&lt;td&gt;
&lt;img src="http://<vizworldserver>:10301/FeatureThumbnail/?feature=Country"&gt;&lt;/td&gt;&lt;td&gt;Country&lt;br&gt;&lt;a href="http://<vizworldserver>:10301/PlaceFinder/?Search=(null)"&gt;Get Image&lt;/a&gt;&lt;br&gt;See Towns:&lt;a href="http://<vizworldserver>:10301/Browse/?id=71f2d1c100001200&amp;filter=Capital,Town 1m,Town 100k"&gt;13 Major Towns&lt;/a&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</summary>
<updated>2010-07-07T15:22:39Z</updated>
<author><name>VizWorldServer</name></author>
<thumbnail url="http://<vizworldserver>:10301/FeatureThumbnail/?feature=Country"/>
<link rel="up" type="application/atom+xml;type=feed" href="http://<vizworldserver>:10301/Browse/"/>
<link rel="self" type="application/atom+xml;type=entry" href="http://<vizworldserver>:10301/PlaceFinder/?Search=Belgium"/>
<link rel="alternate" type="application/atom+xml;type=feed" href="http://<vizworldserver>:10301/Browse/?id=71f2d1b900001200"/>
<link rel="down" type="application/atom+xml;type=feed" href="http://<vizworldserver>:10301/Browse/?id=71f2d1b900001200"/>
<content type="application/atom+xml;type=feed">
<MapFeature>
<FeatureID>1000000000001200</FeatureID>
<Name>Belgium</Name>
<DBName>Belgium</DBName>
<AlterName>Belgium</AlterName>
<Type>Country</Type>
<GeoPoint>4.466875, 50.259453</GeoPoint>
<Diameter>280.409729</Diameter>
<FullDesc>Belgium</FullDesc>
</MapFeature>
</content>
</entry>