My favorites API
Any user can mark documents (from the document management module) as a personal favorite. And via one of the portal overview screen the user can manage those favorites and even create new one to anything using the hyperlink manager.
REST API and WCF API are available for the retrieval of a list of favorites for the logged on user. For each favorite, an information object is returned which can be used to redirect the user to the iProva screen which allows him to view the content marked as favorite.
The REST API also supports creating, updating, reordering and deleting the favorites.
The REST API for favorites can be used to accomplish the scenario’s listed below:
- Retrieve the list of favorites for a user
- Create new favorite
- Remove a favorite
- Alter the text or order of a favorite
General API usage information
Overview of important information for consumers of the iProva REST API, with topics like versioning, verbs, status codes, authentication and error handling.
Overview of changes and announced deprecations regarding the iProva REST API.
Our code samples on GitHub show you how to get started with the iProva REST API.
A detailed reference for this API is provided in Swagger format.
Please note that the Swagger reference is also present in each customer’s iProva tenant. You can find it by adding /api to the URL of the customer’s iProva tenant. For example: https://organisation.iprova.nl/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s iProva, and you need valid credentials for the customer’s iProva.