Open
Registry
2.0
Documentation

register_object

Purpose

This operation adds an object to a collection of objects and returns an indicator of success. OpenRegistry only supports the registration of objects in the form of text strings or URLs as part of this operation. While other types of objects can be accomodated within an OpenRegistry, their registration requires the implementation of a custom interface that is not specified as part of this standard.

URL Syntax (HTTP POST)

http://foo.bar/foo/collections/{collection_id}/register

Where

  • {collection_id} is the collection identifier as listed in the registry.collections response

Mandatory Request Parameters

Parameters that must be found in the body of the request include:

Name Type Description
object string Object locator or text. May be a URL (in the case of a collection of URLs), or a text string (in the case of a controlled vocabulary).

Optional Request Parameters

Parameters that may be present in the body of the request include:

Name Type Description
tag string Comma-separated list of keywords that describe the object.
time string A time or a range of times in ISO 8601 format according to the W3C profile found at http://www.w3.org/TR/NOTE-datetime (e.g. "1997-07-16" or "1997-07-16T19:20:30+01:00". A range of times takes the form "MinTime..MaxTime" (e.g. "1997-07-16..1997-08-16").
latlong string A point or a pair of decimal degree coordinates in WGS84. Point coordinates take the form "Lat,Long" (e.g. "45,-77"), while a pair of coordinates takes the form "S,W..N,E". E.g. "45,-77..46.5,-74.2".
minmax string A numeric value or range of values whish is defined for each collection (e.g. map scale). A range of values takes the form "Minimum..Maximum" (e.g. "50000..100000").
rating string Numeric rating, on a scale of 0 - 10, where 0 is the worst possible rating and 10 is the best.

Note: All parameter names are case sensitive.

Examples

Where the body of the POST request might contain

object=http://foo.bar/foo
tag=road,highway
time=1997-07-16
latlong=45,-77..46.5,-74.2
minmax=50000..100000
rating=10

Response Forms

The normal response is a HTML document (mime type = text/plain). The layout, structure, and precise content of this document are determined by the owner of the registry.