Create A Role

Events2HVAC currently only requires read-only access to the schedule data.  If you want to define a specific role to reduce the access to other endpoints in the API, you’ll need to define a new role and assign it to the integration client you created earlier.

Click the “Roles” and select “New Role

 

Add the required routes by selecting the routes from the left side (available routes) and moving them to the right side (selected routes).

 

 

 

Minimum required routes needed for Events2HVAC:

 

Area

Method

Endpoint

Client Authentication

POST

/api/v1/clientauthentication

Bookings

GET

/api/v1/bookings

Bookings

GET

/api/v1/bookings/{id}

Bookings

POST

/api/v1/bookings/actions/search

Buildings

GET

/api/v1/buildings

Event Types

GET

/api/v1/eventtypes

Rooms

GET

/api/v1/rooms

Statuses

GET

/api/v1/statuses

Note:  Future updates may require additional routes to be added to the role.  To prevent issues after updating software, include all GET endpoints (for read-only) or select “All Routes” to cover everything.

Click the “Save Role” button.

Edit your client integration and assign the new role to the client.