clause_8_collection.adoc

Requirements Class "Record Collection"

Overview

requirements/requirements_class_record-collection.adoc

This requirements class defines the requirements for a record collection.

A collection is an object that provides information about and access to a set of related records. Such a collection of records is also referred to as a catalogue.

The schema for the collection resource is an extension of the collection schema defined in OGC API - Features.

While OGC API - Features defines a specific location for the collection resource (path: /collections/{collectionId}), OGC API - Records only fixes the location of the collection in the Record API conformance class. Otherwise the collection resource can live anywhere the provider wishes to place it including as a static file in web space (e.g. a web-accessible directory or an S3 bucket).

Record collection schema

Table 1 defines the set of properties that may be used to describe a collection of records.

Table 1. Table of collection properties

Queryables	Requirement	Description
id	required	A unique identifier to the collection.
title	required	A human-readable name given to the collection.
description	optional	A free-text description of the collection.
links	required	A list of links for navigating the API (e.g. link to previous or next pages; links to alternative representations, etc.)
extent	optional	The spatio-temporal coverage of the collection.
itemType	required	Fixed to the value "record".
crs	optional	A list of coordinate reference systems used for spatial-temporal values.
type	required	The nature or genre of the resource. Fixed to "Collection".
keywords	optional	A list of free-form keywords or tags associated with the collection.
language	optional	The natural language used for textual values (i.e. titles, descriptions, etc) of a collection.
created	optional	The date the collection was created.
updated	optional	The more recent date on which the collection was changed.
providers	optional	A list of providers qualified by their role.
themes	optional	A knowledge organization system used to classify the collection.
contactPoint	optional	An entity to contact about the collection.
license	optional	A legal document under which the collection is made available.
rights	optional	A statement that concerns all rights not addressed by the license such as a copyright statement.
properties	optional	Additional catalogue-specific properties describing the catalogue can be added here.

Note	The properties id, title, description, links, extent, itemsType and crs were inherited from OGC API - Features.

requirements/record-collection/REQ_mandatory-queryables.adoc

recommendations/record-collection/PER_common-mark.adoc

recommendations/record-collection/PER_additional-queryables.adoc

Keywords and Themes

See Keywords and Themes for a record.

Links

requirements/record-collection/REQ_links.adoc

recommendations/record-collection/PER_links.adoc

Templated links with variables

See Templated links with variables for a record.

Language negotiation

See Language negotiation for a record.

Encodings

This specification defines requirements for JSON and HTML encoding of a catalogue. See Encodings.