Models
======

Model List
----------

This provides a list of forecast models.

::

    GET /models

Request Examples
~~~~~~~~~~~~~~~~

See :ref:`headers` for request header details.

::

    $ curl -X GET http://model.api.wdtinc.com/models

Response Example
~~~~~~~~~~~~~~~~

See :ref:`status_codes` for response code details.

::

    HTTP/1.1 200 OK

::

    [
      {
        "id": "380a6486-e24e-11e6-9421-0e16d24ff930",
        "description": "WeatherOps Tropical Storm",
        "name": "weatherops-tropical-global",
        "forecasts": "/models/380a6486-e24e-11e6-9421-0e16d24ff930/forecasts"
      },
      {
        "id": "c8dc9720-3011-11e7-affd-0a7752e6ac78",
        "description": "WeatherOps Global",
        "name": "weatherops-global",
        "forecasts": "/models/c8dc9720-3011-11e7-affd-0a7752e6ac78/forecasts"
      },
      {
        "id": "3029a416-e24e-11e6-9421-0e16d24ff930",
        "description": "WeatherOps Superconus",
        "name": "weatherops-superconus",
        "forecasts": "/models/3029a416-e24e-11e6-9421-0e16d24ff930/forecasts"
      }
    ]

----

Model Information
-----------------

This provides information about a particular forecast model.

::

    GET /models/{model-id-or-name}

Request Examples
~~~~~~~~~~~~~~~~

See :ref:`headers` for request header details.

::

    $ curl -X GET http://model.api.wdtinc.com/models/380a6486-e24e-11e6-9421-0e16d24ff930

::

    $ curl -X GET http://model.api.wdtinc.com/models/weatherops-tropical-global

Response Example
~~~~~~~~~~~~~~~~

See :ref:`status_codes` for response code details.

::

    HTTP/1.1 200 OK

::

    {
      "id": "380a6486-e24e-11e6-9421-0e16d24ff930",
      "name": "weatherops-tropical-global",
      "description": "WeatherOps Tropical Storm",
      "forecasts": "/models/380a6486-e24e-11e6-9421-0e16d24ff930/forecasts"
    }

Model Variables
---------------
These are the variables that are required to exist in each of a model's forecasts.

::

    GET /models/{model-id-or-name}/variables

Request Example
~~~~~~~~~~~~~~~

See :ref:`headers` for request header details.

::

    $ curl -X GET http://model.api.wdtinc.com/models/weatherops-tropical/variables

Response Example
~~~~~~~~~~~~~~~~

::

    [
      {
        "description": "tropical wind direction forecast in degrees",
        "name": "wind-direction"
      },
      {
        "description": "tropical wind speed forecast in knots",
        "name": "wind-speed"
      },
      {
        "description": "probability of tropical wind speed greater than 34 knots",
        "name": "34kt-wind-probability"
      },
      {
        "description": "probability of tropical wind speed greater than 64 knots",
        "name": "64kt-wind-probability"
      },
      {
        "description": "probability of tropical wind speed greater than 50 knots",
        "name": "50kt-wind-probability"
      },
      {
        "description": "tropical wind gust forecast in knots",
        "name": "wind-gust"
      },
      {
        "description": "tropical quantitative precipitation forecast in millimeters",
        "name": "precipitation"
      }
    ]