def post_udi_event():
"""API endpoint to post UDI event.
.. :quickref: User; Upload flexibility constraints to the platform
**Example request A**
This "PostUdiEventRequest" message posts a state of charge (soc) of 12.1 kWh at 10.00am
as UDI event 203 of device 10 of owner 7.
.. code-block:: json
{
"type": "PostUdiEventRequest",
"event": "ea1.2018-06.io.flexmeasures.company:7:10:203:soc",
"value": 12.1,
"unit": "kWh",
"datetime": "2015-06-02T10:00:00+00:00"
}
**Example request B**
This "PostUdiEventRequest" message posts a state of charge (soc) of 12.1 kWh at 10.00am,
and a target state of charge of 25 kWh at 4.00pm,
as UDI event 204 of device 10 of owner 7.
.. code-block:: json
{
"type": "PostUdiEventRequest",
"event": "ea1.2018-06.io.flexmeasures.company:7:10:204:soc-with-targets",
"value": 12.1,
"unit": "kWh",
"datetime": "2015-06-02T10:00:00+00:00",
"targets": [
{
"value": 25,
"datetime": "2015-06-02T16:00:00+00:00"
}
]
}
**Example response**
This "PostUdiEventResponse" message indicates that the UDI event has been processed without any error.
.. sourcecode:: json
{
"type": "PostUdiEventResponse",
"status": "PROCESSED",
"message": "Request has been processed."
}
:reqheader Authorization: The authentication token
:reqheader Content-Type: application/json
:resheader Content-Type: application/json
:status 200: PROCESSED
:status 400: INCOMPLETE_UDI_EVENT, INVALID_MESSAGE_TYPE, INVALID_TIMEZONE, INVALID_DATETIME, INVALID_DOMAIN,
INVALID_UNIT, OUTDATED_UDI_EVENT, PTUS_INCOMPLETE, OUTDATED_UDI_EVENT or UNRECOGNIZED_UDI_EVENT
:status 401: UNAUTHORIZED
:status 403: INVALID_SENDER
:status 405: INVALID_METHOD
"""
return v1_3_implementations.post_udi_event_response()
def post_udi_event():
return v1_3_implementations.post_udi_event_response()
def post_udi_event():
"""API endpoint to post UDI event. (UDI is the Universal Device Interface proposed by USEF for flexible device states)
.. :quickref: Control; Upload flexibility constraints to the platform
**Example request A**
This "PostUdiEventRequest" message posts a state of charge (soc) of 12.1 kWh at 10.00am
as UDI event 203 of device 10 of owner 7.
.. code-block:: json
{
"type": "PostUdiEventRequest",
"event": "ea1.2021-01.io.flexmeasures.company:7:10:203:soc",
"value": 12.1,
"unit": "kWh",
"datetime": "2015-06-02T10:00:00+00:00"
}
**Example request B**
This "PostUdiEventRequest" message posts a state of charge (soc) of 12.1 kWh at 10.00am,
and a target state of charge of 25 kWh at 4.00pm,
as UDI event 204 of device 10 of owner 7.
The minimum and maximum soc are set to 10 and 25 kWh, respectively.
Roundtrip efficiency for use in scheduling is set to 98%.
.. code-block:: json
{
"type": "PostUdiEventRequest",
"event": "ea1.2021-01.io.flexmeasures.company:fm0.7:10:204:soc-with-targets",
"value": 12.1,
"unit": "kWh",
"datetime": "2015-06-02T10:00:00+00:00",
"targets": [
{
"value": 25,
"datetime": "2015-06-02T16:00:00+00:00"
}
],
"soc_min": 10,
"soc_max": 25,
"roundtrip_efficiency": 0.98
}
**Example response**
This "PostUdiEventResponse" message indicates that the UDI event has been processed without any error.
.. sourcecode:: json
{
"type": "PostUdiEventResponse",
"status": "PROCESSED",
"message": "Request has been processed."
}
:reqheader Authorization: The authentication token
:reqheader Content-Type: application/json
:resheader Content-Type: application/json
:status 200: PROCESSED
:status 400: INCOMPLETE_UDI_EVENT, INVALID_MESSAGE_TYPE, INVALID_TIMEZONE, INVALID_DATETIME, INVALID_DOMAIN,
INVALID_UNIT, OUTDATED_UDI_EVENT, PTUS_INCOMPLETE, OUTDATED_UDI_EVENT or UNRECOGNIZED_UDI_EVENT
:status 401: UNAUTHORIZED
:status 403: INVALID_SENDER
:status 405: INVALID_METHOD
"""
return v1_3_implementations.post_udi_event_response()