DispatchOne Solution
Facility API
Property and Facility Lifecycle
5min
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 property lifecycle 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 { "tostate" "active\ available", "reasoncode" "r 104", "data" {} } facility lifecycle 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 { "tostate" "active\ available", "reasoncode" "r 104", "data" {} }