Skip to content

Latest commit

 

History

History
133 lines (104 loc) · 9.13 KB

URI-conventions.md

File metadata and controls

133 lines (104 loc) · 9.13 KB
permalink
/URI-conventions.html

Loc-I URI conventions

Web identifiers (URIs) for Loc-I resources must conform to AGLDWG URI Conventions.

Definitions

http://linked.data.gov.au/def/{scope}(/#){defID}

Datasets

http://linked.data.gov.au/dataset/{datasetID}

Data items

http://linked.data.gov.au/dataset/{datasetID}[/{collectionID}](/#){individualID}

Classes and Feature-types

Ontology {scope} separator {defID}
ASGS asgs # MeshBlock
StatisticalAreaLevel1
StatisticalAreaLevel2
StatisticalAreaLevel3
StatisticalAreaLevel4
StateOrTerritory
Country
G-NAF gnaf # Address
StreetLocality
Locality
GeoFabric geofabric # ContractedCatchment
DrainageDivision
RiverRegion
Loc-I loci # DataPublisher
Dataset
DatasetLinkingStatement
Feature
Linkset

Data

Examples of URI patterns for specific datasets:

Dataset {datasetID} {collectionID} separator
ASGS asgs2016 meshblock
statisticalarealevel1
statisticalarealevel2
statisticalarealevel3
statisticalarealevel4
stateorterritory
australia
/
G-NAF gnaf address
streetLocality
locality
/
GeoFabric geofabric contractedcatchment
drainagedivision
riverregion
/
Meshblock-ControlledCatchment links mb16cc statement /

Examples

ASGS Summary and examples

Example individual Class Collection
http://linked.data.gov.au/dataset/asgs2016/meshblock/50259230000 http://linked.data.gov.au/def/asgs#MeshBlock http://linked.data.gov.au/dataset/asgs2016/meshblock
http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel1/50102100504 http://linked.data.gov.au/def/asgs#StatisticalAreaLevel1 http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel1
http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel2/308031218 http://linked.data.gov.au/def/asgs#StatisticalAreaLevel2 http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel2
http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel3/80106 http://linked.data.gov.au/def/asgs#StatisticalAreaLevel3 http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel3
http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel4/207 http://linked.data.gov.au/def/asgs#StatisticalAreaLevel4 http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel4
http://linked.data.gov.au/dataset/asgs2016/stateorterritory/2 http://linked.data.gov.au/def/asgs#StateOrTerritory http://linked.data.gov.au/dataset/asgs2016/stateorterritory
http://linked.data.gov.au/dataset/asgs2016/australia/036 http://linked.data.gov.au/def/asgs#Country http://linked.data.gov.au/dataset/asgs2016/australia
http://linked.data.gov.au/dataset/mb16cc/statement/to98614 http://linked.data.gov.au/def/loci#LinkingStatement http://linked.data.gov.au/dataset/mb16cc

Note: in the 2nd-last line, for the SAL6 'Australia' the individual and collection URIs use /australia/ rather than the class name i.e. /country/ . This follows a pattern inherited from the ASGS reference.

G-NAF Summary and examples

Example individual Class Collection
http://linked.data.gov.au/dataset/gnaf/address/GAACT714845933 http://linked.data.gov.au/def/gnaf#Address http://linked.data.gov.au/dataset/gnaf/address
http://linked.data.gov.au/dataset/gnaf/streetLocality/NSW2856338 http://linked.data.gov.au/def/gnaf#StreetLocality http://linked.data.gov.au/dataset/gnaf/streetLocality
http://linked.data.gov.au/dataset/gnaf/locality/198023 http://linked.data.gov.au/def/asgs#Locality http://linked.data.gov.au/dataset/gnaf/locality

Geofabric Summary and examples

Example individual Class Collection
http://linked.data.gov.au/dataset/geofabric/contractedcatchment/9550009 http://linked.data.gov.au/def/geofabric#ContractedCatchment http://linked.data.gov.au/dataset/geofabric/contractedcatchment
http://linked.data.gov.au/dataset/geofabric/drainagedivision/9400214 http://linked.data.gov.au/def/geofabric#DrainageDivision http://linked.data.gov.au/dataset/geofabric/drainagedivision
http://linked.data.gov.au/dataset/geofabric/riverregion/9400228 http://linked.data.gov.au/def/geofabric#RiverRegion http://linked.data.gov.au/dataset/geofabric/riverregion

Summary of AGLDWG URI guidelines

Names in the linked.data.gov.au domain must follow the AGLDWG URI Guideline.

Definitions

The URI pattern for a definition (i.e. a class, concept, controlled-vocabulary or vocabulary item) is:

http://linked.data.gov.au/def/{scope}(/#){defID}

where {scope} identifies the vocabaulary or ontology, and {defID} the class, concept, property-type, vocabaulary item, etc.

Data

Dataset

The URI pattern for a dataset as a whole is:

http://linked.data.gov.au/dataset/{datasetID}

(Optional) Collection

The URI pattern for a collection within a dataset is:

http://linked.data.gov.au/dataset/{datasetID}/{collectionID}

In Loc-I cache all individuals from a class are allocated to a collection for that class with the URI http://linked.data.gov.au/dataset/{datasetID}/{collectionID}. This is used for paging in pyLDAPI.

Item

Individual items in a dataset (such as geographic features or entities) are denoted by a URI which is an extension of the dataset URI or collection URI, following the pattern:

http://linked.data.gov.au/dataset/{datasetID}[/{collectionID}](/#){individualID}

N.B. If the optional /{collectionID} path element is included, and corresponds with a class name, then the classification of each item must be known when the identifier is assigned, and can compromise some lifecycle transitions (e.g. re-classification of an individual feature). Furthermore, since some individuals are members of more than one class, a single {collectionID} can make the identifier ambiguous or non-unique.

OGC API

The recently released OGC API - Features - Part 1: Core specifies a set of URI patterns for accessing features. This is similar to the Loc-I/AGLDWG, but with different keywords and a slightly deeper structure.

Terminology

  • feature = individual item
  • collection = dataset

Schemas

Response structure is defined in a set of YAML patterns

Note that the response must be provided in HTML and JSON, other formats optional.

URI patterns for Data

Resource + spec-link relative URI pattern response + example
Service / Landing page
API description /api Swagger with API details
Conformance /conformance List of conformance classes implemented by this service
Collections /collections List of collections available from this service
Specific collection /collections/{collectionId} Description of a collection (but not including the members)
Features /collections/{collectionId}/items List of members of a collection
Specific feature /collections/{collectionId}/items/{featureId} Description of a feature