Schemas

Address

cityrequired

stringThis field refers to the city, town, or locality where the address is located.

country

stringThis field specifies the name of the country where the address is located.

postalCode

stringThis field represents the numeric or alphanumeric code assigned to a specific area for efficient mail sorting and delivery.

streetrequired

stringThis field represents the name of the road, street, or thoroughfare where the address is located. The field should also contain the building number assigned to a building at the location, and the field should also contain identifiers such as apartment numbers, suite numbers, or floor numbers.

AllDayScheduling

All-day event scheduling information

endDaterequired

string (date)End date in RFC3339 _full-date_ format.

startDaterequired

string (date)Start date in RFC3339 _full-date_ format.

typerequired

string enumall_dayType of scheduling for all-day events

ConfigurationContentResponseBody

uiLanguages

objectThis contains the ui language settings. All ui language codes should be on this list https://www.loc.gov/marc/languages/

ContactInfo

Contact information for registration and tickets. At least one of the fields must be provided: `url`, `email`, `phone`, or `info`.

email

string (email)Email for registration/tickets

info

stringInstructions on where to register/buy tickets

phone

stringPhone number with country prefix for registration/tickets

url

string (uri)URL to registration/ticket page

Error

coderequired

ErrorCode

inforequired

ErrorInfo

ErrorCode

A number representing the type of error. List of error codes: - \<error code\>: \<error description\> - 500: System error - 600: Unsupported Open Library API version - 10001: Endpoint disabled - 71001: Consent has not been given for 'loan history' - 100001: Wrong patron username or password - 100023: Patron ID not found - 100211: maxNumberOfEmailAddresses exceeded - 100215: maxNumberOfPhoneNumbers exceeded - 100221: Pickup location cannot contain sections - 100411: Updating patron consent failed - 100611: Updating patron notification settings failed - 101001: Reservation ID not found - 101047: Branch ID cannot be used as pick up branch - 101053: Section ID cannot be used as pick up branch - 102001: Loan ID not found - 102301: Loan not renewable, because it is an interlibrary loan - 102311: Loan not renewable, because it is reserved - 110001: Branch ID not found - 200001: Publication ID not found - 200077: ui language not supported - 200101: missing required query parameter - 200103: invalid/unsupported query parameter value - 300001: Initialize payment should not be used - 300005: Initialize payment should be used - 300009: Payment method not supported - 300013: Payment method does not support partial payment - 300301: Finalized payment can not de changed - 300311: FinalizePaymentRequest.fees contains fees with the same ID - 310001: Loan history ID not found - 310011: Loan history ID already exists - 330001: List ID not found - 330011: List ID already exists - 330101: List item ID not found - 330111: List item ID already exists

ErrorInfo

Starts with the text matching the error code field (defined above), and a describing text could be added.

Errors

errorsrequired

array of ErrorThe first error should always be the most relevant.

Event

Complete event information. Only the field `description` can contain formatting.

admissionrequired

EventAdmission

audiences

array of EventAudienceTarget audiences for the event

branchrequired

EventBranch

categories

array of EventCategoryEvent categories

descriptionrequired

stringA detailed description of the event. Is in limited html format. Supports following html tags - b - i - p - a - ul - ol - li

idrequired

stringUnique identifier for the event. If multi events have the same 'id' but different language, then they are the same event.

images

array of ImageTypeContent

language

stringThe language of this events content (https://www.loc.gov/marc/languages/).

location

EventLocation

organizers

array of EventOrganizerEvent organizers

promoted

Promoted

relatedEvents

RelatedEvents

relevantWorks

RelevantWorks

schedulingrequired

EventScheduling

series

EventSeries

staterequired

EventState

teaser

stringA short, engaging text designed to spark interest in the event

titlerequired

stringEvent title

updateTimerequired

string (date-time)When was the event last update (or create) in RFC3339 _date-time_ format.

url

string (uri)URL to the event's webpage

EventAdmission

Admission and registration information for an event

EventAudience

Information about an audience target for an event

idrequired

stringUnique identifier for the audience target

labelrequired

stringLocalized label for the audience target

EventBranch

Branch information, this is the main branch associated with the event.

branchIdrequired

stringThe branch ID (should exist in GET /locations)

branchNamerequired

stringName of the branch

EventCategory

Category classification for events

idrequired

stringCategory identifier

labelrequired

stringLocalized category label

EventLocation

The location where the event takes place

EventLocationAtBranch

Location information for an event at the branch location.

locationrequired

stringThe internal location used for the event

typerequired

string enumat_branch

EventLocationExternal

Location information for an external venue.

address

AddressThe physical address of the event location

namerequired

stringExternal location name

typerequired

string enumexternal

EventOrganizer

Information about an external event organizer

id

stringUnique identifier for the external organizer

namerequired

stringName of the external organizer

EventPriceCategory

amountrequired

integerThe price for a ticket. 0 if free. The amount is in minor unit (see ISO 4217).

currencyrequired

stringThe currency of the price. ISO 4217 code.

label

stringA label for the price, this can been used e.g. as prefix for the price type. E.g. "Adults" or "Children"

EventPricing

Pricing information for an event

EventPricingPriceCategories

categoriesrequired

array of EventPriceCategoryArray of price categories for an event

typerequired

string enumprice_categories

EventPricingSimple

textrequired

stringSimple pricing text, e.g. "0 - 100 DKK"

typerequired

string enumsimple · value

EventScheduling

EventSeries

Information about an event series that this event belongs to

eventIds

array of stringAn array of event ids within the series. This list is restricted to events that fall within the date range specified by the API request. It does not include the event id of the current event itself.

seriesIdrequired

stringIdentifier of the event-series. This searchId can be used with `GET /content/event/series/{seriesId}`.

EventState

The state of the event. There are three event state type - scheduled, Meaning that the event is scheduled and expected to be carried out as planned (See scheduling). - cancelled, Meaning that the event is cancelled. - finished, Meaning that the event is finished.

GetContentEventsInSeriesResponseBody

eventsrequired

array of Event

totalrequired

integerThe total number of events in the series.

GetContentEventsResponseBody

endOfResultsrequired

booleanIf this is false, we haven't reached the end of the search result yet, if it's false we have, and if it's missing or null we don't know.

eventsrequired

array of Event

total

integerThe total number of events in the whole period.

GetVersionResponseBody

versionrequired

VersionThis is recommended (by the provider) version of the Open Library API, that is supported by provider.

ImageAlt

Alternative for accessibility

textrequired

stringAlternative text for accessibility

ImageCredit

Image credit information

textrequired

string

ImageFocalPoint

ImageFocalPointHotspot

Describes the point of the most important part of the image

typerequired

string enumhotspot

xrequired

numberHorizontal position of hotspot (0-1)

yrequired

numberVertical position of hotspot (0-1)

ImageOriginal

The `url' is the un-cropped version of the image

ImageTypeContent

ImageUrl

height

integerThe image height in px.

mime

string enumpng · jpeg

urlrequired

string

width

integerThe image width in px.

OpenAdmission

Open admission with no registration or tickets required

typerequired

string enumopenType of admission - open access

Promoted

endTime

string (date-time)End time in RFC3339 _date-time_ format.

startTime

string (date-time)Start time in RFC3339 _date-time_ format.

typerequired

PromotedType

PromotedType

PromotedTypeEnum

Pre-defined promotion states that we can "switch" on.

PromotedTypeLiteral

Literal promotion states that are unknown beforehand.

QueryRelevantWorks

Relevant works specified as a query string

queryrequired

stringQuery string to find relevant works

typerequired

string enumqueryType of relevant works - query string

RegistrationAdmission

Registration-based admission with contact information

contactInforequired

ContactInfo

staterequired

TicketStateState of the registration

typerequired

string enumregistrationType of admission - registration required

RelatedEvents

Related events

RelevantWorks

Books or other works relevant to the event

TicketAdmission

Ticket-based admission with pricing and capacity

contactInforequired

ContactInfo

pricingrequired

EventPricing

staterequired

TicketStateState of the ticket sale

ticketCapacity

stringTotal number of tickets which can be sold for the event. E.g. "100" or "unlimited"

typerequired

string enumticketType of admission - ticket required

TicketState

State of ticket sales or registration

TimeSpanScheduling

Time-span event scheduling information

endTimerequired

string (date-time)End time in RFC3339 _date-time_ format.

startTimerequired

string (date-time)Start time in RFC3339 _date-time_ format.

typerequired

string enumtime_spanType of scheduling for time-span events

Version

Open Library API version.

WorksRelevantWorks

Relevant works specified as an array of work IDs

typerequired

string enumworksType of relevant works - array of work ids

workIdsrequired

array of stringArray of works