Versions Compared

Key

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

...

A WS request contains one period and a maximum of five substitutes may be specified for that period.
The OoO activates automatically when the time is reached.

GetOoOList

Method

The GetOoOList method is used to list all inserted OoO for the considered eHealthBox. The list contains all OoO:
past, active and future OoO. The OoOId returned can further be used to delete an OoO.

...

The response contains a success status code and as many OoO elements as there are OoO in the considered
eHealthBox. Each element contains all OoO data when it was inserted.

InsertOoO

...

The InsertOoO method is used to insert an OoO for the considered eHealthBox. In order to insert an OoO for
another eHealthBox, BoxId can be used. There are a number of rules and limitations to respect as described in
Apollo: Use case 04: Out-of-Office.

...

The response is “Success” without further details if everything went right. Otherwise the wrong or absent
substitutes will be returned in the response as detailed below.

DeleteOoO

...

The DeleteOoO method is used to delete an OoO for the considered eHealthBox. In order to delete an OoO for
another eHealthBox, BoxId can be used. The OoO Id must be specified. It can be retrieved from InsertOoO, in the
Id element or from GetOoOList.

...