Api.version; Api.ping - Siemens SIMATIC S7-1500 Function Manual

3.20.2.4

Api.Version

Use the Api.Version method to request the current version number of the Web API. You can
draw conclusions from the version number:
● The functions supported by the respective version
● the hardware release number of the CPU
This information allows you to implement applications that correspond to the functionality of
the contacted CPU.
No authorizations are needed for calling the Api.Version method.
Example
The following example shows a possible result of calling the Api.Version method.
1.28
The version number is displayed as a floating -point number and is incremented with every
release and every change in the Web API implementation.
3.20.2.5

Api.Ping

The Api.Ping method outputs a unique ID for the CPU used. You can use it to determine
whether the CPU can be reached. The CPU ID comprises a 28-byte string. The system
assigns a new, unique CPU ID after each restart (POWER ON - POWER OFF) or warm start
of the CPU. By comparing this with previously output IDs, you can also determine whether
the CPU was restarted in the meantime.
No authorizations are needed for calling the Api.Ping method.
Example
The following example shows the output of a CPU ID:
"ZWlmbnJwZmplb3Nwd2l1Y3N3dWE="
Web server
Function Manual, 11/2019, A5E03484625-AG
3.20 API (Application Programming Interface)
Web pages
165