5.9.4 api display text

The PUT /api/display/text function helps you show a message on the device display.

The function is part of the Display API service and the user has to be assigned the Display (Control) privilege for authentication if required.

Methods:
GET – sets the message on the display.
DELETE – removes the message from the display.

GET method

Two input formats are available in JSON:

Message with translations (message[])
Freetext (text)

A combination of the two formats is not supported.

Parameters:

Parameter	Type	Mandatory	Description
uid	string	No	Message identifier for a third party system. Max. length: 40 characters.
response	bootlean	No	Defines whether or not the messages requires a response. Derfault: `false`.
timeout	number	No	Display timeout (in seconds). Default: `3600`. Max. values: `response=true`: `3600` `response=false`: `1209600`
icon	string	No	Message icon. Valid values: `"none"`, `"operator"`, `"technician"`.

Format of the message with translations, message[]key parameters:

Parameter	Type	Mandatory	Description
`language`	string	Yes	Language code (ISO 639).
`text`	string	Yes	Message text in the selected language.

Freetext format:

Parameter	Type	Mandatory	Description
`text`	string	Yes	Message text. Max. length: 1024 characters.

Example of request

{
    "uid": "user_defined_string",
    "message": [
        {
            "language": "en",
            "text": "Hello, how can I help you?"
        },
        {
            "language": "cs",
            "text": "Dobrý den, jak Vám mohu pomoci?"
        }
    ],
    "response": true,
    "timeout": 3600,
    "icon": "operator"
}

Response

{
    "success": true,
    "result": {
        "response": "",
        "uid": "user_defined_string"
    }
}

DELETE method

The request does not contain any parameters.

DELETE /api/display/text
{
    "success": true,
    "result": {
        "uid": "user_defined_string"
    }
}