##################
Wind Gust Duration
##################
========
Overview
========
This portion of the API concerns gust duration events, which are polygon data affecting
a geographic region (defined by an extent) or location (defined by a point).
There are 4 request types, providing various levels of detail. Each response
identifies a possible transition to further information. These can be depicted
as follows:
.. image:: ../images/request_transition.png
:alt: Gustdur Request Transition Diagram
:align: center
Definition of "Event": An event is defined as a 24 hour period of time.
For requests that return a "date", the 24 hour period for that particular event
starts at 6Z on the date returned in the response.
For example, the date "2012-05-03" refers to the 24 hour time period
from 2012-05-03T06:00:00Z to 2013-05-04T06:00:00Z.
=============
Event Summary
=============
This request is the "entry point" for the wind gust duration event portion of the API.
It returns the total number dates where there was an analyzed wind gust of any duration
analyzed at a given location, proximity for a given location with a radius(default unit is mile),
or region within a date range (the last 90 days by default) as `JSON`_ or `XML`_. Links
to the `latest event`_ and `event history`_ (within the same date range) are
included in the response to facilitate client-side transitions.
URI Examples
------------
::
forensic.api.wdtinc.com/v2/gustdur/summary/+DD.ddd-DDD.ddd?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/summary/+DD.ddd-DDD.ddd.xml?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/summary/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/summary/+DD.ddd-DDD.ddd.xml?radius=&begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/summary/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/summary/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd.xml?begin=&end=&u=&t=
See :ref:`request_format` for a description of the parameters.
.. rst-class:: html-toggle
JSON Response
-------------
The JSON representation of a location-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"eventSummary": {
"selfLink": "/v2/gustdur/summary/+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"location": "+DD.ddd-DDD.ddd",
"eventCount": nn,
"eventHistoryLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"latestEventLink": "/v2/gustdur/latest/+DD.ddd-DDD.ddd?begin=&end=&u=&t="
}
}
The JSON representation of a proximity-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"eventSummary": {
"selfLink": "/v2/gustdur/summary/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"location": "+DD.ddd-DDD.ddd",
"eventCount": nn,
"radius": {
"unit": "mile|km",
"value": "DD"
},
"eventHistoryLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=",
"latestEventLink": "/v2/gustdur/latest/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t="
}
}
The JSON representation of a region-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"eventSummary": {
"selfLink": "/v2/gustdur/summary/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"region": "+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd",
"eventCount": nn,
"eventHistoryLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"latestEventLink": "/v2/gustdur/latest/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t="
}
}
.. rst-class:: html-toggle
XML Response
------------
The XML representation of a location-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd
nn
The XML representation of a proximity-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd
nn
DD
The XML representation of a region-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd
nn
============
Latest Event
============
This request returns the most recent gust duration event impacting a given location, or a
proximity with a given location and a radius (default unit is mile), or
region within a date range (all available history by default) as `JSON`_ or
`XML`_. Event details include the ID, date, and maximum estimated gustdur duration in
hours. Links to the `event history`_ (within the same date range) and `event vectors`_ (for the
latest event) are included in the response to facilitate client-side
transitions.
URI Examples
------------
::
forensic.api.wdtinc.com/v2/gustdur/latest/+DD.ddd-DDD.ddd?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/latest/+DD.ddd-DDD.ddd.xml?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/latest/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/latest/+DD.ddd-DDD.ddd.xml?radius=&begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/latest/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/latest/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd.xml?begin=&end=&u=&t=
See :ref:`request_format` for a description of the parameters.
.. rst-class:: html-toggle
JSON Response
-------------
The JSON representation of a location-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"latestEvent": {
"selfLink": "/v2/gustdur/latest/+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"location": "+DD.ddd-DDD.ddd",
"event": {
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
},
"eventHistoryLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd?begin=&end=&u=&t="
}
}
The JSON representation of a proximity-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"latestEvent": {
"selfLink": "/v2/gustdur/latest/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"location": "+DD.ddd-DDD.ddd",
"radius": {
"unit": "mile|km",
"value": "DD"
},
"event": {
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
"vectorsLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd/dddddddddd?radius=&u=&t="
},
"eventHistoryLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t="
}
}
The JSON representation of a region-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"latestEvent": {
"selfLink": "/v2/gustdur/latest/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"region": "+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd",
"event": {
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
"vectorsLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/dddddddddd?u=&t="
},
"eventHistoryLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t="
}
}
.. rst-class:: html-toggle
XML Response
------------
The XML representation of a location-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd
YYYY-MM-DD
DD
The XML representation of a region-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd
DD
YYYY-MM-DD
DD
.. code-block:: xml
+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd
YYYY-MM-DD
DD
=============
Event History
=============
This request returns the history of gust duration events impacting a given location,
or a proximity with a given location and radius (default unit is mile),
or region within a date range (the last 90 days by default) as `JSON`_ or
`XML`_. Event details include the ID, date, and estimated gust duration in
hours. A link to the `event vectors`_ (for each event in the history) is included in the
response to facilitate a client-side transition.
URI Examples
------------
::
forensic.api.wdtinc.com/v2/gustdur/history/+DD.ddd-DDD.ddd?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/history/+DD.ddd-DDD.ddd.xml?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/history/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/history/+DD.ddd-DDD.ddd.xml?radius=&begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/history/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/history/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd.xml?begin=&end=&u=&t=
See :ref:`request_format` for a description of the parameters.
.. rst-class:: html-toggle
JSON Response
-------------
The JSON representation of a location-based resource is structured
as follows (loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"eventHistory": {
"selfLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"location": "+DD.ddd-DDD.ddd",
"events": [
{
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
},
{
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
},
:
:
]
}
}
The JSON representation of a proximity-based resource is structured
as follows (loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"eventHistory": {
"selfLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd?radius=&begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"location": "+DD.ddd-DDD.ddd",
"radius": {
"unit": "mile|km",
"value": "DD"
},
"events": [
{
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
"vectorsLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd/dddddddddd?radius=&u=&t="
},
{
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
"vectorsLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd/dddddddddd?radius=&u=&t="
},
:
:
]
}
}
The JSON representation of a region-based resource is structured as follows
(loosely based on Google's `JSON style guide`_)::
{
"apiVersion": "2.5.3",
"eventHistory": {
"selfLink": "/v2/gustdur/history/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd?begin=&end=&u=&t=",
"dateRange": {
"begin": "YYYY-MM-DDThh:mm:ssZ",
"end": "YYYY-MM-DDThh:mm:ssZ"
},
"region": "+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd",
"events": [
{
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
"vectorsLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/dddddddddd?u=&t="
},
{
"id": "",
"date": "YYYY-MM-DD",
"duration": {
"unit": "hours",
"value": "DD"
},
"vectorsLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/dddddddddd?u=&t="
},
:
:
]
}
}
.. rst-class:: html-toggle
XML Response
------------
The XML representation of a location-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd
YYYY-MM-DD
DD
YYYY-MM-DD
DD
:
:
The XML representation of a proximity-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd
DD
YYYY-MM-DD
DD
YYYY-MM-DD
DD
:
:
The XML representation of a region-based resource is structured as follows
(based on Google's `XML style guide`_):
.. code-block:: xml
+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd
YYYY-MM-DD
DD
YYYY-MM-DD
DD
:
:
=============
Event Vectors
=============
This request returns the vector geometry depicting gust duration events that impacted
a proximity with a given location and radius (default unit is mile),
or region on a given date. Results are returned as `GeoJSON`_ or
`KML`_. No transitions are available from the response. An empty feature
collection is returned if there are no events.
URI Examples
------------
::
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd/ssssssssss?radius=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd/ssssssssss.kml?radius=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd/YYYY-MM-DDThh:mm:ssZ?radius=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd/YYYY-MM-DDThh:mm:ssZ.kml?radius=&u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/ssssssssss?u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/ssssssssss.kml?u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/YYYY-MM-DDThh:mm:ssZ?u=&t=
forensic.api.wdtinc.com/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/YYYY-MM-DDThh:mm:ssZ.kml?u=&t=
See :ref:`request_format` for a description of the parameters.
.. rst-class:: html-toggle
GeoJSON Response
----------------
The GeoJSON representation of a proximity-based resource is structured as
follows::
{
"apiVersion": "2.5.3",
"eventVectors": {
"selfLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd/dddddddddd?radius=&u=&t=",
"date": "YYYY-MM-DD",
"location": "+DD.ddd-DDD.ddd",
"radius": {
"unit": "mile|km",
"value": "DD"
},
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[ [-102.3555, 39.8420], [-99.8945, 39.8420], ... ]
]
},
"properties": {
"id": "",
"duration": {
"unit": "hours",
"value": "DD"
}
}
},
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[ [-96.9941, 36.3148], [-93.2148, 36.3148], ... ]
]
},
"properties": {
"id": "",
"duration": {
"unit": "hours",
"value": "DD"
}
}
},
:
:
]
}
}
The GeoJSON representation of a region-based resource is structured as follows::
{
"apiVersion": "2.5.3",
"eventVectors": {
"selfLink": "/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/dddddddddd?u=&t=",
"date": "YYYY-MM-DD",
"region": "+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd",
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[ [-102.3555, 39.8420], [-99.8945, 39.8420], ... ]
]
},
"properties": {
"id": "",
"duration": {
"unit": "hours",
"value": "DD"
}
}
},
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[ [-96.9941, 36.3148], [-93.2148, 36.3148], ... ]
]
},
"properties": {
"id": "",
"duration": {
"unit": "hours",
"value": "DD"
}
}
},
:
:
]
}
}
.. rst-class:: html-toggle
KML Response
------------
The KML representation of a proximity-based resource is structured as follows:
.. code-block:: xml
Gust duration Events
/v2/gustdur/vectors/+DD.ddd-DDD.ddd/dddddddddd?radius=&u=&t=
YYYY-MM-DD
+DD.ddd-DDD.ddd
DD
8082258
DD
hours
-99.6442,33.3989 -99.6360,33.3777 ...
8082570
DD
hours
-99.6442,33.4089 -99.6370,33.3787 ...
:
:
The KML representation of a region-based resource is structured as follows:
.. code-block:: xml
Gust duration Events
/v2/gustdur/vectors/+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd/dddddddddd?u=&t=
YYYY-MM-DD
+DD.ddd-DDD.ddd+DD.ddd-DDD.ddd
8082258
DD
hours
-99.6442,33.3989 -99.6360,33.3777 ...
8082570
DD
hours
-99.6442,33.4089 -99.6370,33.3787 ...
:
:
.. _`GeoJSON`: http://en.wikipedia.org/wiki/GeoJSON
.. _`JSON`: http://en.wikipedia.org/wiki/JSON
.. _`JSON style guide`: http://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml
.. _`KML`: https://developers.google.com/kml/documentation/
.. _`XML`: http://en.wikipedia.org/wiki/XML
.. _`XML style guide`: http://google-styleguide.googlecode.com/svn/trunk/xmlstyle.html