ItemIdstringrequired
Item accession number.
Retrieve detailed information for a specific item.
This endpoint retrieves detailed information for the item identified by the provided item id.
get
https://openweb-api.nlb.gov.sg/api/v2/Catalogue/GetItem
Query Parameters
Response
application/json
Response
application/json
OK
GetItemResponseModel
* Additional properties are NOT allowed.
irninteger(int32)
Item Internal Identifier.
Example:99999999
itemIdstring
Item Id.
Example:BxxxxxxxJ
brninteger(int32)
Title record Book Reference Number.
Example:99999999
volumeNamestring | null
Volume Identifier.
Example:2023 issue 1
callNumberstring
Call Number.
Example:123.123 ART
formattedCallNumberstring
Formatted Call Number.
Example:English 123.123 -[ART]
mediaobjectrequired
Item Material Type. Please refer to code list C002.
* Additional properties are NOT allowed.
Show Child Parameters
usageLevelobjectrequired
Usage Level. Please refer to code list C004.
* Additional properties are NOT allowed.
Show Child Parameters
locationobjectrequired
Library Location. Please refer to code list C005.
* Additional properties are NOT allowed.
Show Child Parameters
courseCodeobject
Course Code.
* Additional properties are NOT allowed.
Show Child Parameters
languagestring
Language.
Example:English
suffixstring | null
Suffix.
Example:-[ART]
donorstring | null
Item donated by information.
Example:Donated by abc
pricenumber | null(double)
Item price.
Example:9999.99
statusobject
Item Status.
* Additional properties are NOT allowed.
Show Child Parameters
transactionStatusobjectrequired
Item Transactional Status. Please refer to code list C003.
* Additional properties are NOT allowed.
Show Child Parameters
minAgeLimitinteger(int32)
Title age limit.
Example:13
get/GetItem
Query Parameters
application/json
BadRequestError
objectError contents including the specific error
* Additional properties are NOT allowed.
statusCodeinteger(int32)
The status code of the error.
Example:400
errorstringrequired
The type of the error.
>= 1 characters
Example:Bad Request
messagestringrequired
The message of the error.
>= 1 characters
Example:FieldName is missing.
Example
BibFormat
objectBibliographic Formats. Please refer to code list C001.
* Additional properties are NOT allowed.
codestringrequired
Bibliographic Format code.
>= 1 characters
Example:BK
namestringrequired
Bibliographic Format desc.
>= 1 characters
Example:BOOKS
Example
BookCover
object * Additional properties are NOT allowed.
smallstring
Small size image url
mediumstring
Medium size image url
largestring
Large size image url
Example
CheckoutsTitle
object * Additional properties are NOT allowed.
titlestring
Bibliographic title in english
nativeTitlestring
Bibliographic title in native language
authorstring
Author name in english
nativeAuthorstring
Author name in native language
isbnsarray[string]
isbns
checkoutsCountinteger(int32)
Checkouts count for the duration.
Example