...
In order to support other booking systems, ROOMZ has developed a generic connector. This connector will exchange information with any booking system providing the AP following the contract specified in the following sections:
ROOMZ Connector API v1.0
Conventions
The following conventions have been applied for the definition of the API:
The API is communicating using RESTful calls
The returned content is in JSON format
The date and time are always in UTC and ISO8601 format https://www.w3.org/TR/NOTE-datetime ("YYYY-MM-DDThh:mm:ssZ")
The success of the calls is identified by the HTTP status code(e.g. 200=OK, 401=Unauthorized)
There is no null value
Authentication and Encryption
All the requests are executed using a HTTP Basic Authentication. As the credentials are readable, it is highly recommended to provide access to the API with HTTPS only (HTTP over TLS).
Overview
The API must support the following calls:
...
The next sections will describe each call in more details.
Get the list of rooms
Request:
Method | URL |
|---|---|
GET | /rooms |
...
OK --> 200
Unauthorized -> 401
Get the room's meetings
Request:
Method | URL |
|---|---|
GET | /rooms/roomId/meetings?from=2010-12-31T14:00:00Z&to=2013-01-01T08:00:00Z |
...
OK --> 200
Malformed date in the request --> 400
Unauthorized --> 401
Unknown Room ID or Organizer ID --> 404
Create a new meeting
Request:
Method | URL |
|---|---|
POST | /rooms/roomId/meetings |
...
OK --> 200 or 201
Unauthorized --> 401
Unknown Room ID or Organizer ID --> 404
Conflict with existing meeting --> 409
Update an existing meeting
Request:
Method | URL |
|---|---|
PUT | /rooms/roomId/meetings/meetingId |
...
OK --> 200
Malformed information --> 400
Unauthorized --> 401
Unknown Room ID, or Meeting ID --> 404
Conflict with existing meeting --> 409
ROOMZ Connector configuration
On the ROOMZ portal, the following properties must be configured for communicating with the booking system's API:
...