Collection Related Web Services
General Purpose
The Collection Web Services allow users to manage Collections in Rosetta without using the Rosetta UI.
The APIs allow creating, updating and deleting Collections.
Required Role: Data Manager (full).
Available Web Services – SOAP
For specific details for each web-service (input parameters, returned XML) see the javadoc.
| Method | From | Description |
|---|---|---|
| createCollection | 3.1 | Creates a collection |
| deleteCollection | 3.1 | Deletes a collection (collection must not contain members). |
| getCollectionByExternalId | 3.1 | Retrieves a collection based on its external ID. |
| getCollectionById | 3.1 | Retrieves a collection based on its Rosetta Collection ID. |
| getCollectionByName | 3.1 | Retrieves a collection based on its full path. |
| updateCollection | 3.1 | Updates a collection’s fields (any of the following) – Name, parent-ID, descriptive MD, external-ID or Source MD. |
| getCollectionTree | 5.1 | Retrieves a collection and its subcollections, recursively. |
| setCollectionThumbnail | 5.1 | Sets a collection’s thumbnail. |
| deleteCollectionThumbnail | 5.1 | Reverts a collection’s thumbnail to the system default. |
To access the WSDL on your server, go to:
http://<repository-load-balancer-host>:<port>/dpsws/repository/CollectionWebServices?wsdl
Available Web Services – REST
Ex Libris reserves the right to make changes to the API in the future in order to accommodate internal needs.
| Method | Description |
|---|---|
| GET /delivery/services/collections | Returns a hierarchical list of all published collections |
| GET /delivery/services/collections?level={LEVEL} | Returns a hierarchical list of all published collections to the specified depth level |
| GET /delivery/services/collections/{collection_id} | Returns a collection and any of its published subcollections |
| GET /delivery/services/collections/{collection_id}?level={LEVEL} | Returns a collection and any of its published subcollections up to the specified depth level |
Parameters:
- institution={institution_code,institution_code…}: Filters the collections by the collection owner(s). Example: https://rosetta.exlibrisgroup.com/delivery/services/collections?institution=CRS00.INS00,CRS00.INS01
XSDs