Catalogue

Item

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

Location

object

Library Location. Please refer to code list C005.

* Additional properties are NOT allowed.
codestringrequired

Library code

>= 1 characters

Example:AMKPL

namestringrequired

Library Name

>= 1 characters

Example:Ang Mo Kio Public Library

Example

Media

object

Item Material Type. Please refer to code list C002.

* Additional properties are NOT allowed.
codestringrequired

Media Code

>= 1 characters

Example:DV18

namestringrequired

Media Name

>= 1 characters

Example:Digital Video for M18

Example

MethodNotAllowedError

object

Error 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

NewArrivalTitle

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

Bibliographic reference number.

Example:99999999

digitalIdstring

For external query purpose, to get the title or reserve the title in Overdrive

Example:Overdrive Id

otherTitlesarray[string]

Other titles.

nativeOtherTitlesarray[string]

Other titles(Native language).

variantTitlesarray[string]

Varying Form of Title.

nativeVariantTitlesarray[string]

Varying Form of Title(Native language).

otherAuthorsarray[string]

List of other authors.

nativeOtherAuthorsarray[string]

List of other authors(Native language).

isbnsarray[string]

Bibliographic International Standard Book Number identifiers.

Example:9709999999

issnsarray[string]

Bibliographic International Standard Serial Number identifiers.

Example:9999-9999

formatobjectrequired

Bibliographic Formats. Please refer to code list C001.

* Additional properties are NOT allowed.
Show Child Parameters
editionarray[string]

Information relating to the edition of a work.

Example:Di 1 ban

nativeEditionarray[string]

Information relating to the edition of a work(Native language).

Example:第1版

publisherarray[string]

Published by.

Example:[Xi'an] : Wei lai chu ban she

nativePublisherarray[string]

Published by(Native language).

Example:[西安] : 未来出版社

publishDatestring

publish date or year.

Example:2019-

subjectsarray[string]

subjects.

Example:Science -- Experiments -- Juvenile films

physicalDescriptionarray[string]

Title physical dimensions.

Example:283 p. : ill. ; 22 cm

nativePhysicalDescriptionarray[string]

Title physical dimensions(Native language).

Example:283页 : 插图 ; 22公分

summaryarray[string]

Summary of the bibliographic content.

nativeSummaryarray[string]

Summary of the bibliographic content(Native language).

contentsarray[string]

Formatted Contents Note.

nativeContentsarray[string]

Formatted Contents Note(Native language).

thesisarray[string]

Dissertation Note.

nativeThesisarray[string]

Dissertation Note(Native language).

notesarray[string]

notes.

nativeNotesarray[string]

Native notes of the bibliographic record.

allowReservationboolean

Allow to place reservation or not.

Default:true

isRestrictedboolean

true, when title is marked as restricted publication.

Default:false

activeReservationsCountinteger(int32)

Number of reservations placed and in queue, not fullfilled and not expired.

Example:3

audiencearray[string]

Target audience - Marc tag 521 (all).

audienceImdaarray[string]

target audience - Marc tag 521 Ind 3 - Specific to highlight in display.

Example:IMDA Advisory: Parental Guidance recommended.

languagearray[string]

Languages

Example:Chinese

serialboolean

serial indicator.

Default:false

volumeNotearray[string]

Volume information.

Example:Vol. 1 (Jul. 1859)-

nativeVolumeNotearray[string]

Volume information(Native language).

frequencyarray[string]

Publish frequency.

Example:Monthly

nativeFrequencyarray[string]

Publish frequency(Native language).

creditsarray[string]

Creation/Production Credits Note.

nativeCreditsarray[string]

Creation/Production Credits Note(Native language).

performersarray[string]

Participant or Performer Note.

nativePerformersarray[string]

Participant or Performer Note(Native language).

availabilityboolean

true when at least 1 item is “available” status.

sourcestring

Source of the title

Example:Overdrive

volumesarray[string]

Volume name.

Example:2023 issue 2

titlestring

Full title (with author info suffixed by /) of the bibliographic record.

nativeTitlestring

Full title (with author info suffixed by /) of the bibliographic record(Native language).

seriesTitlearray[string]

Series titles.

Example:123 Zhima Jie

nativeSeriesTitlearray[string]

Series titles(Native language).

Example:123芝麻街

authorstring

Author name in english.

Example:Song bing wu de yi xiang shi jie.

nativeAuthorstring

Bibliographic title(Native language).

Example:松饼屋的异想世界

Example