API Docs

__METHOD= GET . __PATH= /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items .

Retrieve Items list

This web service returns a list of Items.

Note: It is possible to retrieve all the items under a bib record using 'ALL' in the holding_id path parameter.

Resource URL

GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items

API Description

URL Parameters

ParameterTypeDescription
mms_idxs:stringThe Bib Record ID.
holding_idxs:stringThe Holding Record ID. May be ALL to retrieve all holdings for a Bib.

Querystring Parameters

ParameterTypeRequiredDescription
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
expandxs:stringOptional.Parameter for enhancing result with additional information. Currently supported: due_date_policy
user_idxs:stringOptional.The id of the user for which the discovery information will be calculated.
current_libraryxs:stringOptional.The current library for the item.
current_locationxs:stringOptional.The current location of the item.
qxs:stringOptional.Search from enum_a, enum_b, chron_i, chron_j, and description. (see Brief Search)
order_byxs:stringOptional. Default: noneThe sort order. Ordering may be selected by chron_i, description, enum_a, enum_b, enum_c, library, location or temporary_location. There is no default.
directionxs:stringOptional. Default: descThe sort direction of desc (default) or asc.

Body Parameters

None

Output

This method returns a Items list object. See doc

Possible Error Codes

CodeMessage
401652General Error - An error has occurred while processing the request.
402203The Bib Record is not valid.
401688Error while retrieving items.
402469Current library is not valid.
60215Current location is not valid.
60216The ordering is not valid.
60106Invalid query format.
60217The offset is too large.