Skip to content
This repository has been archived by the owner on Apr 27, 2020. It is now read-only.

Update timestamp encoding #23

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update timestamp encoding #23

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
508ea05
Documentation update with information about the need of encoding the …
AnnaGolonka May 24, 2019
867c423
Wrong service name fixed
AnnaGolonka May 24, 2019
658bb68
Code review changes
AnnaGolonka May 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions FORECAST-WEATHER-API-BLUEPRINT.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,20 @@ For multiple locations, its recommended to just use the point compression.
The forecasts in the response collection are "flat" to allow easy streaming and filtering on client side.
The forecasts in the response are ordered ascending by field 'validFrom'.

It is important to use encoded timestamps when doing the requests to Point Forecast Service by for example POSTMAN or browser.
To encode properly the timestamp
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To encode properly the timestamp:

  1. Go to https://www.urlencoder.org/ site.
  2. Paste desired timestamp.
  3. Without changing any parameters click "> ENCODE <" button.
  4. Use generated encoded timestamp in the url.

1. go to https://www.urlencoder.org/ site
2. paste desired timestamp
3. without changing any parameters click "> ENCODE <" button
4. use generated encoded timestamp in the url

Example:
URL before encoding (not working):
https://point-forecast.weather.mg/search?locatedAt=-2.44198,50.54282&validUntil=2019-05-26T00:00:00+02:00&timeZone=Europe/London&fields=maxAirTemperatureInFahrenheit,airTemperatureNearGroundInCelsius,relativeGlobalRadiationInPercent,airTemperatureInCelsius,windSpeedInKnots,windSpeedInKilometerPerHour,weatherSymbolCode,airTemperatureInKelvin,sunshineDurationInMinutes,stationLocation&validPeriod=PT1H,PT6H,PT24H
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change endpoint form /search to /forecast/hourly


URL after encoding (working):
https://point-forecast.weather.mg/search?locatedAt=-2.44198,50.54282&validUntil=2019-05-26T00%3A00%3A00%2B02%3A00&timeZone=Europe/London&fields=maxAirTemperatureInFahrenheit,airTemperatureNearGroundInCelsius,relativeGlobalRadiationInPercent,airTemperatureInCelsius,windSpeedInKnots,windSpeedInKilometerPerHour,weatherSymbolCode,airTemperatureInKelvin,sunshineDurationInMinutes,stationLocation&validPeriod=PT1H,PT6H,PT24H

*Fields mapping*

Common names of filed which can be included in all periods: locatedAt,meteoGroupStationId,meteoGroupStationName,stationLocation,stationTimeZoneName,validFrom,validUntil,validPeriod,issuedAt
Expand Down
14 changes: 14 additions & 0 deletions OBSERVATION-WEATHER-API-BLUEPRINT.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,20 @@ code description comment
The 'shipCourseText' returns one of the following values: "not moving", "NE", "E", "SE", "S", "SW", "W", "NW", "N", "unknown".
The 'shipSpeedRangeInKnots' returns one of the following values: "0", "1-5", "6-10", "11-15", "16-20", "21-25", "26-30", "31-35", "36-40", ">40", "unknown".

It is important to use encoded timestamps when doing the requests to Point Observation Service by for example POSTMAN or browser.
To encode properly the timestamp
1. go to https://www.urlencoder.org/ site
2. paste desired timestamp
3. without changing any parameters click "> ENCODE <" button
4. use generated encoded timestamp in the url
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To encode properly the timestamp:

  1. Go to https://www.urlencoder.org/ site.
  2. Paste desired timestamp.
  3. Without changing any parameters click "> ENCODE <" button.
  4. Use generated encoded timestamp in the url.


Example:
URL before encoding (not working):
https://point-observation.weather.mg/observation/hourly?meteoGroupStationIds=10385&observedPeriod=PT0S&fields=meteoGroupStationId,meteoGroupStationName,airTemperatureInCelsius&observedFrom=2019-05-20T09:00:00+02:00&observedUntil=2019-05-21T09:00:00+02:00

URL after encoding (working):
https://point-observation.weather.mg/observation/hourly?meteoGroupStationIds=10385&observedPeriod=PT0S&fields=meteoGroupStationId,meteoGroupStationName,airTemperatureInCelsius&observedFrom=2019-05-20T09%3A00%3A00%2B02%3A00&observedUntil=2019-05-21T09%3A00%3A00%2B02%3A00

*Gap filling*

GapFilling allows to gap fill missing observations with forecast data from Point Forecast service for following parameters:
Expand Down