Catalogue

CourseCode

object

Course Code.

* Additional properties are NOT allowed.
codestringrequired

Course Code.

>= 1 characters

Example:N1001

clusterNamestringrequired

Cluster Name.

>= 1 characters

Example:Lifestyle Design

categoryNamestring

Category Name.

Example:Culture & Society

Example

Facet

object
* Additional properties are NOT allowed.
idstring

facet name identifier to use in the query string parameter

Example:materialType

namestring

facet name to display in the UI.

Example:Material Type

valuesarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
Example

FacetData

object
* Additional properties are NOT allowed.
idstring

facet data identifier to use the query string parameter.

Example:audioBook

datastring

facet data name to display in the UI.

Example:Audio Book

countinteger(int32)

facet data count.

Example:17

Example

GetAvailabilityInfoResponseV2

object
* Additional properties are NOT allowed.
setIdinteger(int32)

Search result dataset id.

totalRecordsinteger(int32)

Total number of records for this search(dataset).

Example:999

countinteger(int32)

Number of records returned in the response.

Example:999

hasMoreRecordsboolean

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

Default:false

nextRecordsOffsetinteger(int32)

Value to pass in Offset parameter to navigate to next page.

Example:20

itemsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
Example

GetItemResponseModel

object
* 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

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

Suffix.

Example:-[ART]

donorstring

Item donated by information.

Example:Donated by abc

pricenumber(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

Example