Holdings Items Update

Web service for adding holdings information from a local library system to (or removing such information from) bibliographic records in the Open Search data well. Holdings information are stored in a separate index as a part of the data well. Subsequently, these data can be used to limit search results, eg. only retrieve materials that are currently available at a given library or branch.

This service will only work with version 3.5 of the Open Search data well, as older versions do not have indexes for local holdings informtion.

Versions

VersionEndpointEnvironmentWSDL
1.1https://holdingsitemsupdate.addi.dk/holdingsitemsupdate-1.1/HoldingsItemsUpdateServicesProductionWSDL
1.1https://holdingsitemsupdatestaging.addi.dk/holdingsitemsupdate-1.1/HoldingsItemsUpdateServicesStagingWSDL
1.1https://oss-services.dbc.dk/holdingsitemsupdate-1.1/HoldingsItemsUpdateServicesTestWSDL

Service operations:

The service has three operations: holdingsItemsUpdate, completeHoldingsItemsUpdate, and onlineHoldingsItemsUpdate. 

The holdingsItemsUpdateRequest can contain data for up until 100 bibliographic items. For the holdingsItemsUpdateRequest each bibliographic item can have up to 100 holdings associated.

The completeHoldingsItemsUpdateRequest can contain data for one bibliographic item. Each item can have an unlimited amount of holdings associated.

A holding consists of one or more holdings items. Each item that is part of a holding typically represents a specific copy of the bibliographic item. 

The onlineHoldingsItemsUpdateRequest can contain data for up until 100 online bibliographic items. Each item can be marked as having an online holding (true/false).

An update will take place only if all items included in the request can be processed. That means, that if one item in a request fails, an error message will be returned and none of the included items will be updated.

For removal of existing holdings from an item in the data well, the completeHoldingsItemsUpdate-operation must be used.

In case of any discrepancy between the documentation on this page and the WSDL/XSD of a specific version of the web service, the WSDL/XSD is to be considered the authoritative source.

holdingsItemsUpdate/completeHoldingsItemsUpdate/onlineHoldingsItemsUpdate-parameters:

Parameter:

Must be present:

Repeatable:

Sub element of:

Description:

holdingsItemsUpdateRequest/
completeHoldingsItems-UpdateRequest/onlineHoldings-ItemsUpdateRequest

yes

no

holdingsItemsUpdate/
onlineHoldingsItemsUpdate/
completeHoldingsItemsUpdate

 

authentication

no

no

holdingsItemsUpdateRequest/
onlineHoldingsItemsUpdateRequest/
completeHoldingsItemsUpdateRequest

Authentication parameters

groupIdAut

no

no

authentication

Identifier of the service requester (most often a library number)

passwordAut

no

no

authentication

Service requester's password

userIdAut

no

no

authentication

Service requester's user name

agencyId

yes

no

holdingsItemsUpdateRequest/
onlineHoldingsItemsUpdateRequest/
completeHoldingsItemsUpdateRequest

Library identifier code

bibliographicItem

yes

yes

holdingsItemsUpdateRequest

The bibliographic record for which holdings will be updated

completeBibliographicItem

yes

no

completeHoldingsItemsUpdateRequest

The bibliographic record for which the complete holdings will be updated

onlineBibliographicItem

no

yes

onlineHoldingsItemsUpdateRequest

The bibliographic record for which online holdings will be updated

bibliographicRecordId

yes

no

bibliographicItem/
completeBibliographicItem

Unique identifier of bibliographic record (often FAUST)

note

no

no

bibliographicItem/
completeBibliographicItem

Note for bibliographic item. For serials, this can be used to describe which volumes are kept/loanable, like: Last 3 volumes

modificationTimeStamp

yes

no

bibliographicItem/
completeBibliographicItem/
onlineBibliographicItem

Time stamp

modificationDateTime

yes

no

modificationTimeStamp

Date and time for modification

modificationMilliSeconds

yes

no

modificationTimeStamp

Number of milliseconds (0-999)

hasOnlineHolding

yes

no

onlineBibliographicItem

Boolean

holding

no

yes

bibliographicItem/
completeBibliographicItem

Holdings information for bibliographic record

expectedDeliveryDate

no

no

holding

Used if one or more copies are available for loan

readyForLoan

yes

no

holding

Number copies available for loan. -1 if no items are available for loan

issueId

yes

no

holding

Unique id of the holding

issueText

yes

no

holding

Display text for the issue id

holdingsItem

no

yes

holding

Information about each item in holdings

itemId

yes

no

holdingsItem

Unique id of the item. Id of the specific copy of the bibliographic item

branch

yes

no

holdingsItem

Branch at which the item is placed

department

yes

no

holdingsItem

Department of branch (eg. books, music)

location

yes

no

holdingsItem

Eg. DK5-classmark

subLocation

yes

no

holdingsItem

Eg. part of author name or title

circulationRule

yes

no

holdingsItem

Rules about loaning possibilities

status

yes

no

holdingsItem

Status of item. Possible values: NotForLoan, OnLoan, OnOrder, OnShelf, Online, Decommissioned

accessionDate

yes

no

holdingsItem

Accession date for the specific copy.

trackingId

no

no

holdingsItemsUpdateRequest/
onlineHoldingsItemsUpdateRequest/
completeHoldingsItemsUpdateRequest

Unique id to track this service request

 

holdingsItemsUpdateResponse-parameters:

Parameter:

Always present:

Repeatable:

Sub element of:

Description:

holdingsItemsUpdateResult

yes

no

holdingsItemsUpdateResponse

 

holdingsItemsUpdateStatus

yes

no

holdingsItemsUpdateResult

Status of the update. Update will only take places if all the items included in the requests suceed. Possible values: ok, failed_invalid_agency, failed_invalid_delivery_date, failed_update_internal_error

holdingsItemsUpdateStatusMessage

no

no

holdingsItemsUpdateResult

Further info if holdingsUpdateStatus differs from ok