Skip to content

Latest commit

 

History

History
163 lines (126 loc) · 11.1 KB

URI-conventions.md

File metadata and controls

163 lines (126 loc) · 11.1 KB
Raw
permalink
/URI-conventions.html

Loc-I URI conventions

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

Data

Datasets

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

Data items

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

Examples

ASGS

ABS Structures

The 'ABS Structures' within ASGS are updated for each census - 2011, 2016, 2021 etc. Each release is considered to be a new dataset - asgs2011, asgs2016, etc.

URI explanation
http://linked.data.gov.au/dataset/asgs2016/meshblock/20675580000 MB 20675580000 from 2016 ASGS dataset
http://linked.data.gov.au/dataset/asgs2011/statisticalarealevel1/20703116718 SA1 20703116718 from 2011 ASGS dataset
http://linked.data.gov.au/dataset/asgs2016/statisticalarealevel1/20703116718 SA1 20703116718 from 2016 ASGS dataset
Non-ABS Structures

'Non-ABS Structures' are revised more frequently. There is a new release of Non-ABS Structures each year, which includes feature-types (entity-types) for which one or more individuals have changed. For example, Electoral Districts (EDs) (Commonwealth and State) are in a release if there have been adjustments to boundaries (which is not every year). Each new release mentions all individuals of the entity-type, including those that have not changed.

'Non-ABS Structures' are composed from 'ABS Structures' (usually Meshblocks or SA1s) taken from the most recent release. Thus, Non-ABS Structures described between 2011-2015 are composed from asgs2011 ABS Structures, while Non-ABS Structures described between 2016-2020 are composed from asgs2016 ABS Structures

The Non-ABS stuctures are considered to be from a single dataset 'asgs', with the release date appended to the URI at an entity-level (rather than dataset-level which is used for ABS Structures).

URI explanation
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/208/2011-07 CED 208 (Chisholm) from 2011 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/208/2013-07 CED 208 (Chisholm) from 2013 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/208/2016-07 CED 208 (Chisholm) from 2016 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/208/2017-07 CED 208 (Chisholm) from 2017 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/207/2018-07 CED 207 (Chisholm) from 2018 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/207 CED 207 (Chisholm) from current (most recent) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/208/2018-07 CED 208 (Cooper) from 2018 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/208 CED 208 (Cooper) from current (most recent) release of the ASGS CEDs

The local-identifier assigned by ABS for a CED is composed of (i) a number indicating the state (2=VIC) concatenated with (ii) the sequential number of the electorate from its position in an alphabetically-ordered list. In 2018 Chisholm changed from CED 208 to CED 207, because the electorate of Batman (CED 203 in 2017) was renamed to Cooper (CED 208 in 2018) which shuffled the numbers in the range 203-208. Use of the CED number makes it more difficult to track changes in an electorate over time, so it may be preferable to utilize the electorate name in the identifier instead (this is the official identifier assigned by the AEC). However, it is also important not to confuse electorates with the same name in different States/Territories (Fraser has been used in ACT and VIC). So scoping the identifier by state is probably still useful for this and other reasons.

Proposed URI explanation
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-chisholm/2011-07 CED 208 (Chisholm) from 2011 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-chisholm/2013-07 CED 208 (Chisholm) from 2013 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-chisholm/2016-07 CED 208 (Chisholm) from 2016 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-chisholm/2017-07 CED 208 (Chisholm) from 2017 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-chisholm/2018-07 CED 207 (Chisholm) from 2018 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-chisholm CED 207 (Chisholm) from current (most recent) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-cooper/2018-07 CED 208 (Cooper) from 2018 (July) release of the ASGS CEDs
http://linked.data.gov.au/dataset/asgs/commonwealthelectoraldivision/vic-cooper CED 208 (Cooper) from current (most recent) release of the ASGS CEDs

Similar issues apply to SEDs and to a lesser extent to LGAs.

G-NAF

URI Explanation
http://linked.data.gov.au/dataset/gnaf/address/GAACT714845933 Address GAACT714845933
http://linked.data.gov.au/dataset/gnaf/streetLocality/NSW2856338 StreetLocality NSW2856338
http://linked.data.gov.au/dataset/gnaf/locality/198023 Locality 198023

Geofabric

URI Explanation
http://linked.data.gov.au/dataset/geofabric/contractedcatchment/9550009 Contractedcatchment 9550009
http://linked.data.gov.au/dataset/geofabric/drainagedivision/9400214 Drainagedivision 9400214
http://linked.data.gov.au/dataset/geofabric/riverregion/9400228 Riverregion 9400228

Classes and Feature-types

Feature types are implemented as 'classes' with URIs in the /def/ namespace.

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

Summary of AGLDWG URI guidelines

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

Note that version 2.1 of the AGLDWG URI Guideline specifies the use of https: throughout. We are considering how to migrate the current systems to HTTPS.

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