Web Service - DYFI
A web service to retrieve and upload Did You Feel It(DYFI) information in either JSON format or as plain binary data.
- Example queries:
- Get JSON based felt report list: /quakelink/dyfi/query?format=json&feltafter=2020-07-01&feltbefore=2020-07-01T12:00:00
- Get felt reports of particular event: /quakelink/dyfi/query?format=json&id=gempa2020abcd
- Add felt report: curl -X POST -H 'Content-Type: application/json' -d @report.json http://localhost:18080/quakelink/dyfi/report -u "user:password"
- Update felt report: curl -X PUT -H 'Content-Type: application/json' -d @report.json http://localhost:18080/quakelink/dyfi/report -u "user:password"
API Description
| Parameter | Type | Description |
|---|---|---|
| DYFI report attributes | ||
| id | string | Specify the event id, example id=gfz2011ocqa. |
| publicID | string | Public ID of the DYFI report |
| minitensity | float | Specify the minimum intensity. |
| maxitensity | float | Specify the maximum intensity. |
| Rectangular bounding area | ||
| minlat | degrees | Specify minimum latitude, southern boundary [-90 <= X <= 90]. |
| maxlat | degrees | Specify maximum latitude, northern boundary [-90 <= X <= 90]. |
| minlon | degrees | Specify minimum longitude, western boundary [-180 <= X <= 180]. |
| maxlon | degrees | Specify maximum longitude, eastern boundary [-180 <= X <= 180]. |
| Circular bounding area | ||
| region | list | Define bounding area by latitude and longitude in degree and radius in km e.g., 50.39;11.07;261.965. To provide the distance in degree append the unit 'deg' to the number, e.g., 2.3deg. |
| arrival | list | Define travel time template of S phase by latitude, longitude, depth in km, origin time as ISO string, maximum distance in km and maximum residual in seconds. |
| Time queries | ||
| feltbefore | date | Select DYFI reports felt before this date, format = %Y-%m-%d[T%H:%M:%S]. |
| feltafter | date | Select DYFI reports felt after or at this date, format = %Y-%m-%d[T%H:%M:%S]. |
| updatedbefore | date | Select DYFI reports updated before this date, format = %Y-%m-%d[T%H:%M:%S]. |
| updatedafter | date | Select DYFI reports updated after or at this date, format = %Y-%m-%d[T%H:%M:%S]. |
| Miscellaneous attributes | ||
| agency | string | Agency creating the DYFI report. |
| status | string | Evaluation status of the DYFI Report. |
| type | string | DYFI report type, e.g. 'earthquake', 'not existing'. |
| Options | ||
| sort | string | Result set order. Use time for ascending and -time for descending origin time order. |
| limit | integer | Limits the result set. A value > 0 is required. |
| offset | integer | Index the result set should start on. '0' |
| format | string | Specify the output format. Available options are: binary and json. |