VAS API 2.0 Documentation (DRAFT)

An overview of the main VAS API endpoints. The CCMA collection is public data so no authentication is required to access it. If you have a JSON-viewer extension installed in your browser, you should also be able to navigate between most id.cerdi URIs.

Features

Feature Endpoint (geojson) - all features for CCMA collection

Used for efficient map display https://id.cerdi.edu.au/ccma/data/sosa/feature.geojson

Sample response (1 feature)

{
    type: "FeatureCollection",
    features: {
        1: {
            type: "Feature",
            id: 1,
            geometry: {
            type: "Point",
            coordinates: [
                143.733932,
                -37.559189
            ]
        },
        geometry_name: "hasGeometry",
        properties: {
            feature_id: "https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.1",
            feature_type: "http://inspire.ec.europa.eu/featureconcept/SoilLayer",
            feature_name: "ccma.soil.feature.1",
            feature_label: "0-10 cm",
            site_code: "1",
            context_jobnumber: "https://id.cerdi.edu.au/ccma/data/schema/dataset/ccma.schema.dataset.000001"
        }
        }
    }
}

Feature Endpoint (JSON-LD) - all features for CCMA collection

https://id.cerdi.edu.au/ccma/data/sosa/feature

Sample response (1 feature)

The hasFeatureRelationshipTo and hasFeatureRelationshipFrom allow a feature model to be built up from any feature response.

{
    @graph: [
        {
        @id: "https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.1",
        @type: "http://inspire.ec.europa.eu/featureconcept/SoilLayer",
        name: "ccma.soil.feature.1",
        provider: "ccma",
        inDataset: "https://id.cerdi.edu.au/ccma/data/schema/dataset/ccma.schema.dataset.000001",
        description: null,
        prefLabel: "0-10 cm",
        altLabel: "1",
        hasGeometry: {
            @type: "gsp:Geometry",
            gsp:asWKT: "<http://www.opengis.net/def/crs/EPSG/0/4326> POINT(143.733932 -37.559189)",
            description: "1_C1"
        },
        depth: {
            upperBoundary: {
                @value: 0
            },
            lowerBoundary: {
                @value: 10
            },
            unit: {
                @id: "https://qudt.org/vocab/unit/CentiM",
                label: "Centimetre"
            }
        },
        upperDepth: 0,
        lowerDepth: 10,
        hasFeatureRelationshipTo: [
            {
                @id: "https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.6426",
                @type: "http://inspire.ec.europa.eu/featureconcept/SoilBody",
                natureOfRelationship: "part of"
            },
            {
                @id: "https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.6816",
                @type: "http://inspire.ec.europa.eu/featureconcept/SoilLayer",
                natureOfRelationship: "same as"
            }
        ],
        hasFeatureRelationshipFrom: [
            {
                @id: "https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.6816",
                @type: "http://inspire.ec.europa.eu/featureconcept/SoilLayer",
                natureOfRelationship: "same as"
            }
        ],
        hasFeatureConstituents: null
        }
    ]
}

Feature Endpoint (JSON-LD) - Single Feature

https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.14

Observations

Observations Endpoint (JSON-LD) - Single observation from CCMA dataset

https://id.cerdi.edu.au/ccma/data/sosa/observation/ccma.soil.observation.699

@graph: {
    @id: "https://id.cerdi.edu.au/ccma/data/sosa/observation/ccma.soil.observation.699",
    @type: "Observation",
    name: "ccma.soil.observation.699",
    provider: "ccma",
    inDataset: "https://id.cerdi.edu.au/ccma/data/schema/dataset/ccma.schema.dataset.000001",
    phenomenonTime: {
        @type: "http://www.w3.org/2001/XMLSchema#dateTimeStamp",
        @value: "2015-02-11T14:51:13"
    },
    resultTime: {
        @type: "http://www.w3.org/2001/XMLSchema#dateTimeStamp",
        @value: "2015-02-11T14:51:13"
    },
    usedProcedure: {
        @id: "http://anzsoil.org/def/au/fed-uni/procedure/EXCH-CA",
        @type: "Concept",
        name: "Exchangeable Calcium procedure",
        label: "Exchangeable Calcium procedure",
        notation: "EXCH-CA",
        description: "A procedure for measuring Exchangeable Calcium"
    },
    soDepth: {
        soMinimumValue: {
            @value: 0
        },
        soMaximumValue: {
            @value: 10
        },
        unit: {
            @id: "https://qudt.org/vocab/unit/CentiM",
            abbreviation: "cm"
        }
    },
    observedProperty: {
        @id: "http://placeholder.cerdi.edu.au/property/exchangeable_calcium",
        @type: "Concept",
        name: "Exchangeable calcium",
        label: "exchangeable calcium",
        notation: null,
        description: "exchangeable calcium"
    },
    hasFeatureOfInterest: {
        @id: "https://id.cerdi.edu.au/ccma/data/sosa/sample/ccma.soil.sample.40.40"
    },
    hasUltimateFeatureOfInterest: {
        @id: "https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.14"
    },
    hasResult: {
        numericValue: 21.69,
        unit: {
            @id: "https://placeholder.cerdi.edu.au/unit/MilliEQUIVALENT-PER-HectoGM",
            abbreviation: "meq.Hg",
            label: "MilliEquivalent per HectoGram"
        }
    },
    hasSimpleResult: 21.69,
    ufoi_id: 14
}

Example request query (based on ODATA spec) for all observations related to a feature/features https://id.cerdi.edu.au/ccma/data/sosa/observation/?or=(hasUltimateFeatureOfInterest->>"@id".eq.https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.6868,hasUltimateFeatureOfInterest->>"@id".eq.https://id.cerdi.edu.au/ccma/data/sosa/feature/ccma.soil.feature.14)

Convenience API's

Used to populate lists and dropdowns in User interface. Work in progress. These are all in need of review and tidying up.

VAS Datasets by provider/collection

https://id.cerdi.edu.au/ccma/data/schema/dataset/

Observed Properties

https://id.cerdi.edu.au/query/observedproperties/ccma

Procedures

https://id.cerdi.edu.au/query/procedures/ccma