Schemas

View as Markdown The page’s .md file Open in ChatGPT Ask questions about the page Open in Claude Ask questions about the page

Every named schema in the specification, one level deep. A field that points at another schema links to it rather than being expanded — the specification references itself in cycles, so expanding would not terminate.

379 schemas · Generated from provider_v0_6_5.yaml Each field is listed as name, then type, then description. A type that names another schema links to it.

Schema index

AddItemToPatronListRequestBody

PatronListItem

AdditionalIdentifier

one of AdditionalIdentifierTypeISBN | AdditionalIdentifierTypeISSN | AdditionalIdentifierTypeEAN | AdditionalIdentifierTypeBibsentBibbi

AdditionalIdentifierTypeBibsentBibbi

typerequired: string enumbibsentBibbi
valuerequired: string

AdditionalIdentifierTypeEAN

digitsrequired: string enum13
typerequired: string enumean
valuerequired: string

AdditionalIdentifierTypeISBN

digitsrequired: string enum10 · 13
typerequired: string enumisbn
valuerequired: string

AdditionalIdentifierTypeISSN

typerequired: string enumissn
valuerequired: string

AddLoanToPatronLoanHistoryRequestBody

acquiredFrom: PatronLoanAcquiredFrom
checkinTime: string (date-time)The date and time the loan was checkin.
checkoutTime: LoanCreatedTime
dueDate: string (date)The due date of the loan at the time of checkin.
itemId: LoanItemId
loanId: LoanId
manuallyAddedrequired: booleanWas the loan added manually by the patron.
publicationIdrequired: LoanPublicationId
publicationMetadata: PublicationFallback

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.

Agent

one of AgentTypePerson | AgentTypeCollective

AgentPersonActiveLiteral

Date or date range the person was active. This is usually only recorded for historical persons where the birth and death dates are uncertain or unknown. A literal value, meaning there are no expected structure or format.

typerequired: string enumliteral
valuerequired: string

AgentRole

one of AgentRoleMarcRelator

Telling the role of an agent, e.g. author, illustrator, editor.

AgentRoleMarcRelator

roleCoderequired: stringA contribution role code from the MARC Code List for Relators.
typerequired: string enummarcRelatorIdentifies the role code as being part of [MARC Code List for Relators](https://www.loc.gov/marc/relators/relaterm.html).

AgentTypeCollective

all of BaseAgent + object

AgentTypePerson

all of BaseAgent + object

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

Amount

integer

The amount is in minor unit (see ISO 4217).

Audience

one of AudienceTypeLiteral | AudienceTypeAgeRange | AudienceTypeAgeGroup

AudienceTypeAgeGroup

coderequired: AudienceTypeAgeGroupCode
name: stringA displayable (human readable) audience group name.
typerequired: string enumageGroup

AudienceTypeAgeGroupCode

any of AudienceTypeAgeGroupCodeEnum | AudienceTypeAgeGroupCodeLiteral

A code that (if set) can be used with the filter `plas.audience.ageGroup` to search on this age group.

AudienceTypeAgeGroupCodeEnum

string enum child · youngAdult · adult

AudienceTypeAgeGroupCodeLiteral

string

AudienceTypeAgeRange

*from* and *to* isn't required, but a least one of them should be set.

code: stringA code that (if set) can be used with the filter `plas.audience.ageRange` to search on this age range. The formatting is "from:to", "form:*" or "*:to" (replace the `form` and `to` value)
from: integer
to: integer
typerequired: string enumageRange

AudienceTypeLiteral

A literal audience, meaning there are no expected structure or format.

code: stringA code that (if set) can be used with the filter `plas.audience.literal` to search on this audience literal.
typerequired: string enumliteral
valuerequired: stringA displayable (human readable) audience literal.

AuthenticationClientAccessToken

string

The access token string, as issued by the authorization server. It is strongly recommended that this token be a JWT so that it can be validated by a business partner, if e.g. the search API is delegated.

AuthenticationClientCredentialsRequestBody

all of OAuthClientIdAndSecret + object

AuthenticationClientExpiresIn

integer

The duration (in seconds) of time the access token is granted for.

AuthenticationClientResponseBody

access_tokenrequired: AuthenticationClientAccessToken
expires_inrequired: AuthenticationClientExpiresIn
token_typerequired: AuthenticationClientTokenType

AuthenticationClientTokenType

string enum

The type of the token.

Bearer

BaseAgent

description: stringThis is a description of the agent.
fullNamerequired: stringThis is the full name of the agent.
id: stringThis isn't required, but if it's set: - The agent is searchable through the GET /agent endpoint. - Or you can search using the filter `plas.agent` to search on this agent.
images: array of ImageAgentImages of the agent.

BaseSuggestionAgent

fullNamerequired: stringThis is the full name of the agent.
id: stringThis isn't required, but if it's set, the agent is searchable through the GET /agent endpoint.
images: array of ImageAgentImages of the agent.

BasicTitle

language: LanguageThe language of the titles in the object.
mainrequired: stringThis is the main title.
part: objectThis contains the information to distinguish the work.
remainder: stringThis is the remainder of the title.

Binding

one of BindingTypeLiteral

BindingTypeLiteral

A literal binding, meaning there are no expected structure or format.

typerequired: string enumliteral
valuerequired: stringA displayable (human readable) representation of the binding.

CheckinField

acquiredFrom: PatronLoanAcquiredFrom
dueDate: string (date)This is the due date of the checkin item, meaning the date where item should (at the latest) be returned.
itemIdrequired: stringThis is the item ID of the checked in item.
loanIdrequired: LoanId
patronId: stringThis is the patron ID of the patron that made the checkin.
publicationId: stringThis is the publication ID of the checkin item.
publicationMetadata: PublicationFallback
sortingCode: stringThis is the sorting code, and can be used to sort checked in items, on e.g. a self service machine by reserved and not-reserved items.
transactionDateTimerequired: string (date-time)This is the registered time and date of the checkin.

CheckinRequestBody

checkinrequired: object

CheckinResponseBody

checkinrequired: CheckinField
completed: booleanThis tells if the checkin was completed or not. It is only true if the checkin was completed, else it is false.
message: CheckOutOrInMessage
requestIdrequired: stringThis is a unique identifier for the checkout request. This will change for each request.
statusrequired: string enumcompleted · failedThis tells the status of the checkin. The status are: - `completed` means that the checkin went well and was completed. - `failed` means that the checkin failed, and the item was not checked in.

CheckoutAcknowledgementType

typerequired: stringThis is the type of what is to be acknowledged.

CheckoutAcknowledgementTypeFee

all of CheckoutAcknowledgementType + object

CheckoutAcknowledgementTypePreviouslyCheckedOut

all of CheckoutAcknowledgementType + object

CheckoutField

acquiredFrom: PatronLoanAcquiredFrom
dueDaterequired: string (date)This is the due date of the checked out item.
itemIdrequired: stringThis is the item ID of the checkout item.
loanIdrequired: LoanId
patronIdrequired: stringThis is the patron ID of the patron that made the checkout.
publicationId: stringThis is the publication ID of the checkout item.
publicationMetadata: PublicationFallback
renew: LoanRenewInfo
transactionDateTimerequired: string (date-time)This is the registered time and date of the checkout.

CheckOutOrInLocationWithoutNames

The object tells the location where a checkout or checkin was made. The `sections` is for specifying the location more precisely.

branchIdrequired: stringThe branch ID where the checkout or checkin was made.
sections: array of LocationSectionElementWithIdNameAndTypeThis is specifying the location more precisely.

CheckOutOrInMessage

Both type and text are optional, but at least one of them must be set.

text: stringMessage to the patron.
type: stringThis can be used instead of the text field to identify the message type. This can be used by a vendor to handle the message or control the content of the message.

CheckoutRequestBody

acknowledgement: objectThis is used to acknowledge the checkout.
checkoutrequired: object

CheckoutResponseBody

acknowledgement: objectIf this is set, the checkout needs to be acknowledged to be completed.
checkoutrequired: CheckoutField
message: CheckOutOrInMessage
requestIdrequired: stringThis is an unique identifier for the checkout request. This will change for each request.
statusrequired: string enumcompleted · failedThis tells the status of the checkout. The status are: - `completed` means that the checkout went well and was completed. - `failed` means that the checkout failed, and the item was not checked out.

Classification

one of ClassificationTypeDewey | ClassificationTypeDK5

ClassificationTypeDewey

name: stringA displayable (human readable) value representation of the dewey number.
numberrequired: stringThe value of the dewey number.
typerequired: string enumdewey

ClassificationTypeDK5

name: stringA displayable (human readable) value representation of the dewey number.
numberrequired: stringThe value of the dk5 number.
typerequired: string enumdk5

ConfigurationContentApi

delegated: object

ConfigurationContentResponseBody

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

ConfigurationContentWithApi

all of object + ConfigurationContentResponseBody

ConfigurationHolding

periodical: ConfigurationHoldingPeriodical

ConfigurationHoldingPeriodical

groupOrdering: array of HoldingPeriodicalGroupTypeThe default ordering of periodical group types is `year`, `volume` and `number`, or `level1`, ..., `level7`. It is strongly discouraged to ever mix the named types and the level* types, but if for some reason another group type order is needed, `groupOrdering` can be used to tell the vendor the ordering of periodicals.

ConfigurationPatron

fields: array of ConfigurationPatronFieldThis contributes with further information about some of the patron fields, like if they are updatable or not, how they are constructed and their limitations. The array should at most contain one element of each type.
identifierTypes: array of objectThis is an array of the patron identifier types that the vendor supports. If this is missing, only the empty identifier type is supported. The empty identifier type is when no identifier type is specified, and it is assumed to be unknown.
identityProviders: array of object
loanHistory: object
login: object
registration: object

ConfigurationPatronField

one of ConfigurationPatronFieldEmails | ConfigurationPatronFieldPhoneNumbers | ConfigurationPatronFieldPickupLocation

ConfigurationPatronFieldEmails

fieldrequired: string enumemails
maxNumberOfEmailAddresses: integerThis tells the maximum number of email addresses that a patron can have, and hence this is also the maximum numbers of email addresses there can be send in a update patron information request. If this value is missing, there is no limits on the number of emails addresses, this is not recommended.
verification: string enumno_verification · verify_by_email- no_verification => No verification - verify_by_email => An email will be sent by the provider to verify the email

ConfigurationPatronFieldPhoneNumbers

fieldrequired: string enumphoneNumbers
landline: object
mobile: object

ConfigurationPatronFieldPickupLocation

fieldrequired: string enumpickupLocation
form: string enumbranch_id_and_sections · only_branch_idThis is the form of the pickup location, i.e. which parts/fields of the pickup location that are in use. If this is missing 'branch_id_and_sections' is this default.

ConfigurationPatronIdentifierType

string enum norway_birth_number · denmark_cpr

ConfigurationPatronIdentityProviderType

string enum

The identity provider type, found in GET /configuration.

norway_min_id · norway_id_portal · denmark_mit_id

ConfigurationPayment

initialize: object
methods: array of ConfigurationPaymentMethodThis is a list of the payment methods that the vendor supports. If this is missing, there are no payment methods available.
partial: booleanIf this is true, the provider allows partial payments. Default is false.

ConfigurationPaymentMethod

type: ConfigurationPaymentMethodType

ConfigurationPaymentMethodType

string enum

This represents the payment method type.

mobile_pay · vipps ·

ConfigurationResponseBody

content: ConfigurationContentWithApi
events: objectevents contain configuration data for events in the LMS. This covers notifications sent to the user and consent changes.
holding: ConfigurationHolding
patron: ConfigurationPatron
payment: ConfigurationPaymentIf this field is missing, the vendor does not support payments.
search: ConfigurationSearchWithApi
versionrequired: stringThis contains the version of the Open Library API.

ConfigurationSearchApi

delegated: object

ConfigurationSearchExpression

clustering: array of array of ExpressionClusteringFieldThis is the providers preferred clustering of publications. This clustering can be used to group publications together, emulating an expression level.

ConfigurationSearchResponseBody

expression: ConfigurationSearchExpression
suggestions: ConfigurationSearchSuggestions
uiLanguages: objectThis contains the ui language settings. All ui language codes should be on this list https://www.loc.gov/marc/languages/
workSearch: object

ConfigurationSearchSuggestions

available: array of ConfigurationSearchSuggestionsFilterAvailableThis tells which filters are available for the `/suggestions` endpoint.
disabled: booleanThis tells the Vendor if the `/suggestions` endpoint is disabled or not. (Default `false`). If this is set to `true`, the Vendor should not make request to the `/suggestions` endpoint.

ConfigurationSearchSuggestionsFilterAvailable

description: stringThis is a description of what type of filter this is.
typerequired: SuggestionsFilterType

ConfigurationSearchWithApi

all of object + ConfigurationSearchResponseBody

ConfigurationWorkSearchFacet

available: array of ConfigurationWorkSearchFacetAvailable

ConfigurationWorkSearchFacetAvailable

description: stringThis is a description of what type of `facet` this is.
typerequired: SearchFacetType

ConfigurationWorkSearchFilter

available: array of ConfigurationWorkSearchFilterAvailable

ConfigurationWorkSearchFilterAvailable

description: stringThis is a description of what type of filter this is.
typerequired: SearchFilterType

ConfigurationWorkSearchSorting

available: array of ConfigurationWorkSearchSortingAvailable

ConfigurationWorkSearchSortingAvailable

This is a description of a sorting type.

description: stringThis is a description of what type of sorting this is.
typerequired: SearchSortingType

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

Contributor

agentrequired: Agent
roles: array of AgentRoleList of roles (e.g. author, illustrator, editor) that the agent played in the creation of this entity.

CreatePatronListRequestBody

PatronList

CreatePatronReservationRequestBody

pickupLocationrequired: PickupLocationWithoutNames
reserveIdrequired: ReserveId

CreatePatronReservationResponseBody

reservationrequired: PatronReservation

Date

one of DateTypeLiteral | DateTypeRFC3339 | DateTypeYear | DateTypeYearRange | DateTypeCentury

DateTypeCentury

The *century* date can be used if we only know which century an event happened.

beforeTheCommonEra: booleanThe default value is *false*, meaning common era, otherwise before the common era.
centuryrequired: integerThe century e.g. 19 century CE (meaning 1801 CE to 1900 CE), 3 century BCE (meaning 300 BCE to 201 BCE)
typerequired: string enumcentury

DateTypeLiteral

A literal date, meaning there are no expected structure or format.

typerequired: string enumliteral
valuerequired: string

DateTypeRFC3339

The *rfc3339* date can be used if we now the date.

daterequired: string (date)RFC3339 _full-date_ format (YYYY-MM-DD).
typerequired: string enumrfc3339

DateTypeYear

The *year* date can be used if we only know which year an event happened.

typerequired: string enumyear
yearrequired: integerEg. 1924

DateTypeYearRange

The *yearRange* date can be used if we only know approx when an event happened. This can also be used give an open ended year range. *from* and *to* isn't required, but a least one of them should be set.

from: integerEg. 1924
to: integerEg. 1979
typerequired: string enumyearRange

DeletePatronRequestBody

acknowledgement: objectThis is used to acknowledge the deletion of the patron. This is used to delete a patron, if an identity provider was used for login (when we can not validated the patron through identifier and password).
patronrequired: objectWhen the patron is not logge in through an identity provider, we use identifier and password (even if the password was not used at login).

DeletePatronResponseBody

acknowledgement: objectThis contains the acknowledgement code, that should be used to begin deletion process.
statusrequired: string enumwaiting_for_acknowledgement · pending · in_progress · done · deletion_errorThis tells the state of the deletion of the patron. The status can be: - `waiting_for_acknowledgement`, to begin the deleting process, call the deletion endpoint with the acknowledgement code. - `pending`, the deletion request is acknowledged, and we are waiting on the process to begin. - `in_process`, the deletion process is in progress. - `done`, the deletion process is done (meaning the patronId does not exist). - `deletion_error`, the deletion process failed.

Description

one of DescriptionTypeLiteral

DescriptionTypeLiteral

A literal description, meaning there are no expected structure or format.

typerequired: string enumliteral
valuerequired: string

Edition

one of EditionTypeLiteral | EditionTypeNumbering

EditionTypeLiteral

A literal edition, meaning there are no expected structure or format.

typerequired: string enumliteral
valuerequired: stringA displayable (human readable) representation of the edition.

EditionTypeNumbering

display: stringA displayable (human readable) representation of the edition.
numberrequired: integerThe edition number.
printing: integerThe printing number of the edition.
typerequired: string enumnumbering

Error

coderequired: ErrorCode
inforequired: ErrorInfo

ErrorCode

integer enum

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

500 · 600 · 100001 · 100023 · 100211 · 100215 · 100221 · 100411 · 100611 · 101001 · 101047 · 101053 · 102001 · 102301 · 102311 · 110001 · 200001 · 200077 · 200101 · 200103 · 300001 · 300005 · 300009 · 300013 · 300301 · 300311 · 310001 · 310011 · 330001 · 330011 · 330101 · 330111

ErrorInfo

string

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

one of OpenAdmission | TicketAdmission | RegistrationAdmission

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

one of EventLocationAtBranch | EventLocationExternal

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

one of EventPricingSimple | EventPricingPriceCategories

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

one of AllDayScheduling | TimeSpanScheduling

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

string enum

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.

scheduled · cancelled · finished

ExpressionClusteringField

one of ExpressionClusteringFieldNamedCreators | ExpressionClusteringFieldNamedContributors | ExpressionClusteringFieldNamedCreatorsAndContributors | ExpressionClusteringFieldNamedMediaTypes | ExpressionClusteringFieldNamedLanguage