Porovnat verze

Klíč

  • Tento řádek byl přidán.
  • Tento řádek byl odstraněn.
  • Formátování bylo změněno.

...

Blok kódu
titleExample
{
        "param": [			// request for reading values of specific parameters
          "sntp_enable",
          "sntp_server",
          "sntp_timeout",
          "sntp_period",
          "dev_sn",
          "test_wr_param"
        ]
      }

//OR
      {
        "param": [ ] 			//request for reading all values of existing parameters:
      }

Response

  • Response code:
    • 200 – OK
    • 400 – Error (bad request)
    • 401 – Unauthorized
    • 500 – Server error
    • 512 - Internal application error
  • Response header: Set-Cookie: session  - Actual session value.
  • Response type: json json 
    Page_break_pdf
Blok kódu
titleJson schema:
"$schema": "http://json-schema.org/draft-07/schema#",
      "title": "get - response",
      "type": "object",
      "properties": {
        "status": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "minLength": 1,
            "pattern": "^[a-z_][a-z0-9_]*$"
          }
        },
        "value": {
          "type": "object",
          "additionalProperties": {
            "type": [
              "string",
              "number",
              "boolean"
            ],
            "minLength": 1,
            "pattern": "^[a-z_][a-z0-9_]*$"
          }
        }
      },
      "required": [
        "value"
      ],
      "additionalProperties": false
}

Meaning of json items:

  •     $.value:
          List of readed parameters.
          Type: object
          List items are in format:
             "<parameter_name>": <parameter_value>
       
  • $.status:
          List of unread parameter values.
          Is present only for response with response code 400 – Bad request.
          Type: object
          Optional.
           
      • Format of list items:
             
      • "<parameter_name>":
      • "<error_status>"

    ...

      • <parameter_name> – name of reported parameter

    ...

      • <error_status> – type of error.

    ...

      • Possible values:

    ...

      • "undefined" – parameter not exists

    ...

      • "no memory" – memory not enough

    ...

      • "access denied" – parameter is not accessible

    ...

      • "error" – general internal error
    Blok kódu
    titleExample
    {
          "status": {
            "sntp_timeout": "undefined",
            "test_wr_param": "acceses_denied"
          },
          "value": {
            "sntp_enable":"no",
            "sntp_server": "ntp.cesnet.cz",
            "sntp_period": 2,
            "dev_sn": "00000013"
          }
    }

    ...