def get_prognosis():
"""API endpoint to get prognosis.
.. :quickref: User; Download prognosis from the platform
**Optional parameters**
- "resolution" (see :ref:`resolutions`)
- "horizon" (see :ref:`beliefs`)
- "prior" (see :ref:`beliefs`)
- "source" (see :ref:`sources`)
**Example request**
This "GetPrognosisRequest" message requests prognosed consumption between 0.00am and 1.30am for charging station 1,
with a rolling horizon of 6 hours before the end of each 15 minute time interval.
.. code-block:: json
{
"type": "GetPrognosisRequest",
"connection": "CS 1",
"start": "2015-01-01T00:00:00Z",
"duration": "PT1H30M",
"horizon": "PT6H",
"resolution": "PT15M",
"unit": "MW"
}
**Example response**
This "GetPrognosisResponse" message indicates that a prognosis of consumption for charging station 1 was available
6 hours before the start of each 15 minute time interval.
.. sourcecode:: json
{
"type": "GetPrognosisResponse",
"connection": "CS 1",
"values": [
306.66,
306.66,
0,
0,
306.66,
306.66
],
"start": "2015-01-01T00:00:00Z",
"duration": "PT1H30M",
"unit": "MW"
}
:reqheader Authorization: The authentication token
:reqheader Content-Type: application/json
:resheader Content-Type: application/json
:status 200: PROCESSED
:status 400: INVALID_MESSAGE_TYPE, INVALID_SOURCE, INVALID_TIMEZONE, INVALID_UNIT, UNRECOGNIZED_ASSET, or UNRECOGNIZED_CONNECTION_GROUP
:status 401: UNAUTHORIZED
:status 403: INVALID_SENDER
:status 405: INVALID_METHOD
"""
return v1_1_implementations.get_prognosis_response()
def get_prognosis():
return v1_1_implementations.get_prognosis_response()
