Integrate with Facilities

The following how-to sections describe the steps necessary to create and manage Facilities using the Facility Framework APIs.

For more information about the complete set of endpoints available, see the Facility API Reference.

Prerequisites

• An account on the OS1 Platform and a Platform Tenant. For more information, see Getting started with the OS1 Platform.
• Credentials for an App on the OS1 Platform. For more information, see Getting started building Apps.
• An access token. For more information about creating an access token for testing purposes, see Postman Collection or How to use the API 'Try It' feature.
• A mechanism to call the endpoints. You can use our Postman Collection or the “Try It!” feature in our API Documentation for testing purposes.

To create a Facility, you must:

• Create a Property. For more information, see How to: Create a Property.
• Create a Facility to map with the created Property. For more information, see How to: Create a Facility.

Additionally, you can:

• Update the details of a particular Property with Property ID. For more information, see How to: Update a Property.
• Update the details of a particular Facility with Facility ID. For more information, see How to: Update a Facility.
• Retrieve the existing Properties. For more information, see How to: Retrieve Property.
• Retrieve the existing Facilities. For more information, see How to: Retrieve Facility.
• Retrieve Property state. For more information, see How to: Retrieve State of a Property.
• Retrieve Facility state. For more information, see How to: Retrieve State of a Facility.
• Update Property state. For more information, see How to: Change the State of a Property.
• Update Facility state. For more information, see How to: Change the State of a Facility.