Connectivity

The connectivity object describes the intervals at which the client will connect to the API for various operations.

The example below, shows a fully populated connectivity object, please refer to field definitions relating to scenarios whereby fields will be omitted.

Field Definitions
Name Description Required
configuration_check_time The time of day that the client should get its configuration with the Signagelive API No – if the configuration_interval_scheme is not set to ‘regularinterval’ this field will be omitted.
configuration_check_interval The interval expressed in minutes that the client should get its configuration No – if the configuration_interval_scheme is not set to ‘timeofday’ this field will be omitted.
configuration_interval_scheme Identifies the scheme that the client is configured to connect to the Signagelive API. Possible values are:

  1. regularinterval
  2. timeofday
Yes
health_check_interval The interval expressed in minutes that the client should call the health check notification method – see here for details on health check notification Yes
diagnostics_update_time The time of day that the client will send diagnostics information to the Signagelive API No – if the diagnostics_interval_scheme is not set to ‘regularinterval’ this field will be omitted.
diagnostics_update_interval The interval in minutes the client will send diagnostics information to the Signagelive API – See here for diagnostics calls Yes
diagnostics_interval_scheme Identifies the scheme that the client is configured to send diagnostics information to the Signagelive API. Possible values are:

  1. regularinterval
  2. timeofday
Yes
system_reboot_time The time of day the client should perform an automated reboot. No