search

bcgov / ols-router

BC Advanced Route Planner
https://bcgov.github.io/ols-router/
Apache License 2.0
24 stars 11 forks source link

Add reference data dates to response #348

Open BK01 opened 2 years ago

BK01 commented 2 years ago

Current state: The BC Route Planner response does not include a reference data timestamp.

Test case: Generic route request to display reference dates. https://router.api.gov.bc.ca/directions.json?points=-123.70794%2C48.77869%2C-123.53785%2C48.38200

Proposed future state: Add 2x new reference dates to the BC Route Planner (BCRP) response using the same ISO standard as GBA to allows for vintage comparison between BCRP and GBA.

Format example - ISO 8601 - ‘2020-01-25T08:00:01Z’

Reference date (1): Represents the date when the reference data was last refreshed. Exact element name to be discussed (e.g. dataProcessingTimestamp) Reference date (2): The ITN vintage. The name of the element should be genericized to not include 'ITN' in case of future name change (e.g. roadNetworkTimestamp).

The 2x new date elements could be placed directly below the version element as seen in the Geocoder response.

alixcote commented 1 year ago

@gleeming @cmhodgson GeoBC will be including the ITN vintage version in a separate file in the export package. This file will be called version.tsv. I have attached a sample (although github would not allow me to upload a tsv so I renamed it to csv).

This file may be included as early as the January export package - we will keep you posted.

version.csv

BK01 commented 11 months ago

Validated in BC Route Planner 2.2 (router-dev.api.gov.bc.ca) on Dec 19, 2023.

BK01 commented 11 months ago

Confirmed after the latest data refresh that the dataProcessingTimestamp value was updated.