IdTypestringrequired
It should be set to your type (TitleId or ISBN).
Match pattern:^(TitleId|ISBN)$
Idstringrequired
It should be set to your Id based on type.
<= 50 characters
Checking whether the item is available for loan
This function may be used to retrieve the circulation item(s) detail for the eresources (Currently only available for eBooks from Overdrive).
get
https://openweb-api.stg.nlb.gov.sg/api/v1/EResource/GetAvailabilityInfo
Query Parameters
Response
application/json
Response
application/json
OK
GetAvailabilityInfoResponse
* Additional properties are NOT allowed.
titleIdstring | null
Title Id.
Example:C8011AF3-8051-4B32-AE5C-0253FB34B03E
availableboolean
Available (true or false).
availabilityTypestring | null
Availability type.
Example:Normal
totalCopiesinteger(int32)
Title total copies.
Example:2
totalAvailableCopiesinteger(int32)
Title total available copies.
Example:2
totalReservationCopiesinteger(int32)
Title total on reservation copies.
get/GetAvailabilityInfo
Authentication
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
GetAvailabilityInfoResponse
object * Additional properties are NOT allowed.
titleIdstring
Title Id.
Example:C8011AF3-8051-4B32-AE5C-0253FB34B03E
availableboolean
Available (true or false).
availabilityTypestring
Availability type.
Example:Normal
totalCopiesinteger(int32)
Title total copies.
Example:2
totalAvailableCopiesinteger(int32)
Title total available copies.
Example:2
totalReservationCopiesinteger(int32)
Title total on reservation copies.
Example
InternalServerError
objectError contents including the specific error
* Additional properties are NOT allowed.
statusCodeinteger(int32)
The status code of the error.
Example:500
errorstringrequired
The type of the error.
>= 1 characters
Example:Internal Server Error
messagestringrequired
The message of the error.
>= 1 characters
Example:Internal server error
Example
MethodNotAllowedError
objectError contents including the specific error
* Additional properties are NOT allowed.
statusCodeinteger(int32)
The status code of the error.
Example:405
errorstringrequired
The type of the error.
>= 1 characters
Example:Method Not Allowed
messagestringrequired
The message of the error.
>= 1 characters
Example:The requested resource does not support http method 'PUT'
Example