Websocket Status
++++++++++++++++
.. _websocket_status:

Request/Response messages are used by services to request websocket status from the OCPP service.

Update messages are used by OCPP to inform other services about websocket status changes.

This message will include the fields **csms_url**, **security_profile** and **ocpp_version** if the connection status is connected.

**ocpp_version** is optional so that consumers and producers on older versions of the API remain compatible.


.. jsonschema:: ../../../schemas/WebsocketStatusRequest.json
   :hide_key: /**/additionalProperties

Example::

    {
        "id": "57828133-8cfe-477d-b829-0b60aff90c2a",
        "name": "websocket_status",
        "type": "request",
        "data": {}
    }


.. jsonschema:: ../../../schemas/WebsocketStatusResponse.json
   :hide_key: /**/additionalProperties

----------

Example::

    {
        "id": "57828133-8cfe-477d-b829-0b60aff90c2a",
        "name": "websocket_status",
        "type": "response",
        "data": {
            "status": "connected", #or disconnected
            "identity": "CS_001", #optional
            "csms_url": "ws://csms.example.com:443", #optional
            "security_profile": 1, #optional
            "ocpp_version": "ocpp2.0.1" #optional, one of "ocpp1.6", "ocpp2.0.1", "ocpp2.1"
        }
    }

.. jsonschema:: ../../../schemas/WebsocketStatusUpdate.json
   :hide_key: /**/additionalProperties

----------

Example::

    {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "websocket_status",
        "type": "update",
        "data": {
            "status": "connected", #or disconnected
            "identity": "CS_001", #optional
            "csms_url": "ws://csms.example.com:443", #optional
            "security_profile": 1, #optional
            "ocpp_version": "ocpp2.0.1" #optional, one of "ocpp1.6", "ocpp2.0.1", "ocpp2.1"
        }
    }