Search
K
EResources-Stg

EResource

v1OAS 3.0

REST Web Service to search NLB eResources such as book title, summary and URL etc.

API Base URL
  • Server 1:https://openweb-api.stg.nlb.gov.sg/api/v1/EResource/
Security
X-Api-Key (apiKey)

API Key

Additional Information
Document - Code References

Searching eresources content according to search criteria

This function may be used to search for eresources using query parameter.

At least one of the search fields is required:



  • Title

  • Creator

  • Publisher

  • Subject

  • Keywords

  • ISBN

get
https://openweb-api.stg.nlb.gov.sg/api/v1/EResource/SearchResources

Query Parameters

Titlestring

Title

<= 100 characters

Creatorstring

Creator or Contributor

<= 100 characters

Publisherstring

Publisher

<= 100 characters

Subjectstring

Subject. Please refer to sample list R001.

<= 100 characters

Keywordsstring

Search fields include title, description, abstract, subject, creator, contributor, source or type

<= 100 characters

ISBNstring

The standardised 10-digit or 13-digit international number that uniquely identifies a monographic publication

ContentTypestringrequired

Search content type.

Please specify one of the following:

  • eBooks

  • Magazines and Articles

  • Images

  • Records and Papers

  • Websites

  • Audio Books

  • Digital Books

  • Physical Objects

Match pattern:^(eBooks|Magazines and Articles|Images|Records and Papers|Websites|Audio Books|Digital Books|Physical Objects)$

DataFromarray[string]

Accepts the combination of the sample values below

DataFrom value is case sensitive.

ContentType

 ebooks Magazines and Articles Images Records and Papers Websites Audio Books Digital Books Physical Objects

DataFrom

Apabi

Gale

Netlibrary

Overdrive

LMS

NLB

NLB

NAS

NHB

NAS

NHB

NLB

 NLB Overdrive Overdrive Not applicable

>= 1 items

Limitinteger(int32)

Default:10

>= 1<= 100

SortFieldsstring

Note: Do URL encode the value.

Use Prefix + or - to sort by Ascending or Descending order.

Example:

  • relevance

  • +dateCreated

  • -title

If sort field is not mentioned,sorting will be done by relevance.

<= 50 characters

Offsetinteger(int32)

Default:0

Response

application/json

OK

SearchResourcesResponse

* Additional properties are NOT allowed.
totalRecordsinteger(int32)

The number of records matched by the query. If the query fails this will be 0.

Example:999

nextRecordPositioninteger(int32)

The next position within the result set following the final returned record. If there are no remaining records, this field will be set to 0.

Example:10

hasMoreRecordsboolean

Indicator - if dataset has more records or not for pagination.

Example:10

resultsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
get/SearchResources
 
application/json

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

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

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
 
application/json