Skip to main content

Values

  • ONBOARDING

    The device has been registered on the system but has not yet completed the onboarding process. This may include a test charge step, to validate that communication and control of the device is possible within expected limits.

  • PENDING_LIVE

    The device should soon complete the onboarding process.

  • LIVE

    The device has completed the onboarding process and is ready for control.

  • ONBOARDING_TEST_IN_PROGRESS

    There is a test charge in progress for the device.

  • FAILED_ONBOARDING_TEST

    There has been an issue validating that the device can be reliably communicated with or controlled on the system.

  • RETIRED

    The device has no connection details and is not currently available for control.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

"ONBOARDING"