Property and Facility Lifecycle
A lifecycle is the series of states into which a Facility and a Property change as it develops. By looking at the lifecycle, we can find out the current state. A Property or Facility can move between different states on the basis of workflows set in the application using it.
A Property has two states:
- Active - The Property is operational.
- Inactive - The Property is decommissioned and is not operational.
To retrieve the current state of a Property, call the Get Property State endpoint.
To change the state of a Property, call the Update Property State endpoint and pass the following parameters in the request body:
Member | Description |
|---|---|
toState | One of the valid state codes: onboarding, active, deboarding, or inactive. |
reasonCode (optional) | A valid reason code associated with the event. |
data (optional) | Any additional information about the transition. |
Request bodies are specified in JSON format. The following example request body shows how to change the state of the Property:
A Facility has the following five lifecycle states:
- Onboarding - The Facility is being retrofitted or set up for future operations.
- Active - The Facility is operational and is ready to perform transactions.
- Paused - The Facility is operational but can't do active transactions.
- Deboarding - The Facility is non-operational.
- Inactive - The Facility has been decommissioned.
To retrieve the current state of a Facility, call the Get Facility State endpoint.
To change the state of a Facility, call the Transition Facility State endpoint and pass the following parameters in the request body:
Member | Description |
|---|---|
toState | One of the valid state codes: onboarding, active, deboarding, or inactive. |
reasonCode (optional) | A valid reason code associated with the event. |
data (optional) | Any additional information about the transition. |
Request bodies are specified in JSON format. The following example request body shows how to change the state of the Facility: