Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Roomz API application must be hosted on an IBM Domino server with HTTP task enabled. The Roomz API was tested under Domino version 9.0.1 (with Version 12 no issues are known). Using the URL:

Code Block
languagehtml
https://<yourServer>.<yourDomain.xx>/<path to the nsf>/roomz.nsf/services.xsp/api/roomz/v1.0

...

Application

Access rights

Remarks

Roomz API (this application)

AuthorEditor

  • Create Document

The Roomz user creates a log for each call and documents errors as documents

Editor

Tab Advanced:

Maximum Internet name and password: Editor (Minimum)

IBM Domino Directory

Reader

The Roomz user reads all resource database information from the Domino Directory


Reader

Tab Advanced:

Maximum Internet name and password: Reader (Minimum)

Resource DB

Author

  • Create Document

  • Delete Document

The Roomz user reads the appointments for the configured rooms.

If activated on the Roomz Server, the Roomz user can spontaneously reserve the room or release the reservation.


Reader

Tab Advanced:

Maximum Internet name and password: Reader (Minimum)

...

The Roomz API is written on the common base of various resource management systems. For this reason, the version 1.0 specification does not cover all the features of IBM Domino, resp. some functionalities are mapped in the Roomz Server and are not supported by the API. 
Therefore this can be defined in the Roomz Server:

  1. Whether a room can be booked spontaneously. This option is also available for managed resources. This means that spontaneous booking cannot be activated for rooms managed by room administrators.

  2. Releasing a room if the meeting was shorter.This option is also available in the Roomz Server. To do this, the technical user must have author rights to the resource.

Installation

  1. Copy Roomz API based on the template as a new application to the application server.

  2. Sign Roomz API with a Signer ID.

  3. Register the technical user and assign an HTTP password. The technical user does not need a user ID.

  4. Authorize the Technical user to access the Domino Directory, the Roomz API and the resource databases.

  5. Enter URL, username and password in Roomz Server.