Recommendation-Stg

Recommendation

v1OAS 3.0

REST Web Service which returns list of suggested reads from NLB’s libraries, based from NLB recommendation service.

API Base URL
  • Server 1:https://openweb-api.stg.nlb.gov.sg/api/v1/Recommendation/
Security
ApiKey (apiKey)

API Key

Getting recommended content based on search criteria

This function may be used to retrieve recommendations by Type and Id.

get
https://openweb-api.stg.nlb.gov.sg/api/v1/Recommendation/GetRecommendationsForTitles

Query Parameters

RecommendationTypestringrequired

Recommendation Type (ebook, book, work-overdrive, work-physical, subject-physical, subject-overdrive).

Match pattern:^(ebook|book|work-overdrive|work-physical|subject-physical|subject-overdrive)$

Example:book

IdTypestringrequired

Type (patron/title). Use only patron for Recommendation Type (subject-physical, subject-overdrive).

Match pattern:^(patron|title)$

Example:patron

Idstringrequired

Id based on type. Pass in MylibraryID for ebook and MID for (book, work-overdrive, work-physical, subject-physical, subject-overdrive)

Match pattern:^(MylibraryID|MID)$

BirthYearinteger(int32)

>= 1900<= 2025

Example:2000

ReturnModestring

affects the ordering of titles returned

Match pattern:^(offset|random)$

Default:blank (will return the original system ordering)

Example:offset, random

Response

application/json

OK

GetRecommendationResponse

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

BadRequestError

object

Error 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