API Docs

__METHOD= GET . __PATH= /almaws/v1/bibs/collections .

Retrieve Collections

This Web service returns a list of collections.

Resource URL

GET /almaws/v1/bibs/collections

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
levelxs:stringRequiredThe number of levels of sub-collections to retrieve. Optional. For example, 1 = only current; 2 = immediate decendants. Does not work with query. Default is 1.
qxs:stringOptional.Search query. Optional. Does not work with levels parameter. Searching for text in library, collection name, external system or external ID. Multiple search terms may be combined with AND only. For example q=external_system~x%20AND%20external_id~y.

Body Parameters

None

Output

This method returns a Collections object. See doc

Possible Error Codes

CodeMessage
60106Invalid query format.
402469The library query was not valid.