[ Whereis® API Home ] [ JSON API Home ]
Requests and responses involve the repeated exchange of particular objects and data types. The parameters of those objects are described in this section.
Commonly used objects may be grouped into five overarching types: Data Types, Address Types, Geometry Types, Mapping Types, and Return Types.
Object | Object Type | Description |
| Address | Provides a structured address definition | |
| Data | Identifies an area by reference to its top left and bottom right points, articulated as four separate values | |
| Geometric | Defines a circle in terms of pixels, centred on a <point> | |
| Geometric | Defines an ellipse in terms of pixels, centred on a <point> | |
| Return | Returned by the system in response to an Optimised route by handle request. Defines a polyline using offsets from the first point rather than the complete longitude and latitude coordinates for each point | |
| Return | Returned by the system, particularly in response to geocode and reverse-geocode requests, a geocode wraps an address object and provides additional information about it. | |
| Mapping | Defines an image that can be overlaid on the map | |
| Mapping | An array of datasets, each representing a group of geometric or mapping objects to be rendered on the map | |
| Mapping | Wraps an icon and defines its position on the map | |
| Return | Returned in a geometry level detail response | |
| Geometric | Defines a shape similar to an ellipse, but by reference to distance across the ground | |
| Data | Identifies a map location by reference to its longitude and latitude | |
| Geometric | Defines an area as an array of rings | |
| Geometric | Defines a line as an array of <point> objects | |
| Return | Returned in an array in response to a rank request. Defines a point in terms of travel time and distance from a supplied reference point. | |
| Return | Returned in response to a route or route-handle request. Describes a route in two ways: as a set of navigational instructions and in terms of its map geometry | |
| Address | Defines a street by its name, suffix, and type | |
| Mapping | Defines the appearance of a single set of geometric objects specified in <mapData> | |
| Return | Returned in response to a viewport request. Defines the precise bounds returned by an equivalent map request |
For details of request rules and formats, please refer to EMS Services.