API Docs

__METHOD= GET . __PATH= /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/booking-availability .

Retrieve booking availability for an Item

This web service returns list of periods in which specific item is unavailable for booking.

Resource URL

GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/booking-availability

API Description

URL Parameters

ParameterTypeDescription
mms_idxs:stringThe Bib Record ID.
holding_idxs:stringThe Holding Record ID.
item_pidxs:stringThe Item ID.

Querystring Parameters

ParameterTypeRequiredDescription
periodxs:intRequiredThe number of days/weeks/months to retrieve availability for. Mandatory.
period_typexs:stringRequiredThe type of period of interest. Optional. Possible values: days, weeks, months. Default: days.
user_idxs:stringOptional.A unique identifier for the user, for which the booking request is about to be done. Optional. If not supplied, the system will calculate a minimal availability.
user_id_typexs:stringOptional. Default: all_uniqueThe type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table.

Body Parameters

None

Output

This method returns a Booking Availability object. See doc

Possible Error Codes

CodeMessage
401890User with identifier X of type Y was not found.
4018990Unsupported period type.
401652General Error - An error has occurred while processing the request.