Skjemaer

AdditionalIdentifier

AdditionalIdentifierTypeBibsentBibbi

typepåkrevd

string enumbibsentBibbi

valuepåkrevd

string

AdditionalIdentifierTypeEAN

typepåkrevd

string enumean

digitspåkrevd

string enum13

valuepåkrevd

string

AdditionalIdentifierTypeISBN

typepåkrevd

string enumisbn

digitspåkrevd

string enum10 · 13

valuepåkrevd

string

AdditionalIdentifierTypeISSN

typepåkrevd

string enumissn

valuepåkrevd

string

Agent

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.

typepåkrevd

string enumliteral

valuepåkrevd

string

AgentRole

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

AgentRoleMarcRelator

typepåkrevd

string enummarcRelator

Identifies the role code as being part of MARC Code List for Relators.

roleCodepåkrevd

string

A contribution role code from the MARC Code List for Relators.

AgentTypeCollective

AgentTypePerson

Amount

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

BaseAgent

id

string

This 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.

fullNamepåkrevd

string

This is the full name of the agent.

description

string

This is a description of the agent.

images

array of ImageAgent

Images of the agent.

BaseEventItem

eventIdpåkrevd

string

A unique identifier for the event.

typepåkrevd

string

The type of event.

BasicTitle

mainpåkrevd

string

This is the main title.

remainder

string

This is the remainder of the title.

part

object

This contains the information to distinguish the work.

language

Language

The language of the titles in the object.

Binding

BindingTypeLiteral

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

typepåkrevd

string enumliteral

valuepåkrevd

string

A displayable (human readable) representation of the binding.

CheckinField

transactionDateTimepåkrevd

string (date-time)

This is the registered time and date of the checkin.

dueDate

string (date)

This is the due date of the checkin item, meaning the date where item should (at the latest) be returned.

itemIdpåkrevd

string

This is the item ID of the checked in item.

patronId

string

This is the patron ID of the patron that made the checkin.

loanIdpåkrevd

LoanId

publicationId

string

This is the publication ID of the checkin item.

sortingCode

string

This 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.

acquiredFrom

PatronLoanAcquiredFrom

publicationMetadata

PublicationFallback

CheckinFieldWithRequiredPatronId

CheckinResponseBody

statuspåkrevd

string enumcompleted · failed

This 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.

completed

boolean

This tells if the checkin was completed or not. It is only true if the checkin was completed, else it is false.

checkinpåkrevd

CheckinField

message

CheckOutOrInMessage

requestIdpåkrevd

string

This is a unique identifier for the checkout request. This will change for each request.

CheckinWithRequiredPatronIdResponseBody

CheckoutAcknowledgementType

typepåkrevd

string

This is the type of what is to be acknowledged.

CheckoutAcknowledgementTypeFee

CheckoutAcknowledgementTypePreviouslyCheckedOut

CheckoutField

transactionDateTimepåkrevd

string (date-time)

This is the registered time and date of the checkout.

patronIdpåkrevd

string

This is the patron ID of the patron that made the checkout.

itemIdpåkrevd

string

This is the item ID of the checkout item.

publicationId

string

This is the publication ID of the checkout item.

loanIdpåkrevd

LoanId

dueDatepåkrevd

string (date)

This is the due date of the checked out item.

renew

LoanRenewInfo

acquiredFrom

PatronLoanAcquiredFrom

publicationMetadata

PublicationFallback

CheckOutOrInLocationWithoutNames

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

branchIdpåkrevd

string

The branch ID where the checkout or checkin was made.

sections

array of LocationSectionElementWithIdNameAndType

This is specifying the location more precisely.

CheckOutOrInMessage

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

type

string

This 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.

text

string

Message to the patron.

CheckoutResponseBody

statuspåkrevd

string enumcompleted · failed

This 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.

acknowledgement

object

If this is set, the checkout needs to be acknowledged to be completed.

checkoutpåkrevd

CheckoutField

message

CheckOutOrInMessage

requestIdpåkrevd

string

This is an unique identifier for the checkout request. This will change for each request.

Contributor

agentpåkrevd

Agent

roles

array of AgentRole

List of roles (e.g. author, illustrator, editor) that the agent played in the creation of this entity.

Date

DateTypeCentury

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

typepåkrevd

string enumcentury

beforeTheCommonEra

boolean

The default value is false, meaning common era, otherwise before the common era.

centurypåkrevd

integer

The century e.g. 19 century CE (meaning 1801 CE to 1900 CE), 3 century BCE (meaning 300 BCE to 201 BCE)

DateTypeLiteral

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

typepåkrevd

string enumliteral

valuepåkrevd

string

DateTypeRFC3339

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

typepåkrevd

string enumrfc3339

datepåkrevd

string (date)

RFC3339 full-date format (YYYY-MM-DD).

DateTypeYear

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

typepåkrevd

string enumyear

yearpåkrevd

integer

Eg. 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.

typepåkrevd

string enumyearRange

from

integer

Eg. 1924

to

integer

Eg. 1979

Edition

EditionTypeLiteral

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

typepåkrevd

string enumliteral

valuepåkrevd

string

A displayable (human readable) representation of the edition.

EditionTypeNumbering

typepåkrevd

string enumnumbering

numberpåkrevd

integer

The edition number.

printing

integer

The printing number of the edition.

display

string

A displayable (human readable) representation of the edition.

Error

codepåkrevd

ErrorCode

infopåkrevd

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</br>

ErrorInfo

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

Errors

errorspåkrevd

array of Error

The first error should always be the most relevant.

EventConsentChanged

EventFeeDueDateIsApproaching

EventItemAddedToLoanHistory

EventItemCheckin

EventItemCheckout

EventItemPatronListCreated

EventItemPatronListDeleted

EventItemPatronListItemAddedToList

EventItemPatronListItemMovedOnList

EventItemPatronListItemRemovedFromList

EventItemPatronListUpdated

EventItemRemovedFromLoanHistory

EventLoanDueDateIsApproaching

EventPatronDeleted

EventReadyReservationExpiresSoon

EventReceiverRequest

EventReservationExpiresSoon

EventReservationReadyForPickup

EventReservationReminder

Extent

ExtentTypeLiteral

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

typepåkrevd

string enumliteral

valuepåkrevd

string

A displayable (human readable) representation of the extent.

ExtentTypePages

typepåkrevd

string enumpages

pagespåkrevd

integer

Number of physical pages.

ExtentTypePlaytime

typepåkrevd

string enumplaytime

playtimepåkrevd

integer

The total playtime in seconds.

ExtentTypeUnits

typepåkrevd

string enumunits

unitTypepåkrevd

string enumvolume · dvd · cd · bluRay · cassette · lp

unitspåkrevd

integer

Number of physical units (volumes, dvd, cd, ...)

FeeAmount

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

FeeCreatedTime

The date and time the fee was created.

FeeCurrency

ISO 4217

FeeDueDate

The due date of the fee.

FeeId

This is the fee ID.

FeeItem

Item information related to a fee.

itemIdpåkrevd

string

The item identifier of the item that the fee is about.

acquiredFrom

PatronLoanAcquiredFrom

publicationMetadatapåkrevd

PublicationFallback

FeePayableState

This state tells if the fee can be paid and finalized through this API. - *payable*: The fee is payable, and can be finalized through this API. - *not_payable*: The fee cannot be finalized through this API.

FeeRemainingAmount

The remaining amount is the amount that is still payable. If this is not equal to amount, part of the fee has been paid. The amount is in minor unit (see ISO 4217).

FeeType

Defines the type of fee being applied. All fees indicate that the patron should pay, never the other way around. The possible values are: - *fee*: Indicates a regular fee, typically for a late checked-in loan. - *compensation*: Indicates a compensation fee, typically applied due to a damaged or lost item. - *send_to_debt_collector*: Indicates that the fee has been sent to a debt collector because it was not paid in time.

GetVersionResponseBody

versionpåkrevd

Version

This is recommended (by the vendor) version of the Open Library API, that is supported by the vendor.

ImageAgent

ImagePublication

ImageTypeAgent

ImageTypeBackCover

ImageTypeFrontCover

ImageUrl

urlpåkrevd

string

mime

string enumpng · jpeg

width

integer

The image width in px.

height

integer

The image height in px.

Language

codepåkrevd

string

A id that (if set) can be used with the filter plas.language to search on this genre.

Codes can be found at <https://www.loc.gov/marc/languages/>

name

string

A displayable (human readable) value of the language.

LoanCreatedTime

The date and time the loan was made.

LoanDueDate

The latest date on which the loan must be returned.

LoanId

This is the loan ID.

LoanItemId

This is the item identifier of the checkout item.

LoanPublicationId

This is the publication ID of the loan. If this is empty, the publication is unknown.

LoanRenewableState

This tells the renewable state of the loan.

LoanRenewInfo

This contain information about renewal of the loan.

statepåkrevd

LoanRenewableState

count

integer

The number of times this loan can still be renewed. If the field is missing, this information is unknown.

lastDate

string (date)

The date when the loan was last renewed. If the field is missing, this information is unknown.

LocationSectionElementType

This should be the section type of the section (element) ID.

LocationSectionElementWithId

idpåkrevd

string

This is the section (element) ID

LocationSectionElementWithIdAndName

LocationSectionElementWithIdNameAndType

MediaType

code

MediaTypeType

namepåkrevd

string

A displayable (human readable) representation of the media type.

MediaTypeEnum

MediaTypeLiteral

MediaTypeType

A code that (if set) can be used with the filter `plas.mediaTypes` to search on this media type.

PatronConsent

availablepåkrevd

array of object

The array must only contain one consent of each type.

evaluatedpåkrevd

PatronEvaluatedConsents

PatronConsentType

PatronEvaluatedConsent

typepåkrevd

PatronConsentType

givenpåkrevd

boolean

versionpåkrevd

string

The version of the consent that the patron has made a choice for or against.

PatronEvaluatedConsents

The array must only contain one consent of each type.

PatronFee

idpåkrevd

FeeId

typepåkrevd

FeeType

amountpåkrevd

FeeAmount

remainingAmount

FeeRemainingAmount

currencypåkrevd

FeeCurrency

payableStatepåkrevd

FeePayableState

dueDate

FeeDueDate

createdTimepåkrevd

FeeCreatedTime

items

array of FeeItem

The items this fee covers, if they are known.

PatronList

idpåkrevd

string

The ID of the list.

namepåkrevd

string

The name of the list.

PatronListBaseItem

idpåkrevd

string

The unique ID of the item in the list.

PatronListItem

PatronListItemWorkAndPublication

PatronLoan

idpåkrevd

LoanId

publicationIdpåkrevd

LoanPublicationId

createdTimepåkrevd

LoanCreatedTime

itemIdpåkrevd

LoanItemId

dueDatepåkrevd

LoanDueDate

renewpåkrevd

LoanRenewInfo

location

CheckOutOrInLocationWithoutNames

acquiredFrom

PatronLoanAcquiredFrom

publicationMetadata

PublicationFallback

PatronLoanAcquiredFrom

This tells from where (the material for) this loan was acquired. If this field are missing, the default value **local_circulation** should be assumed. * **local_circulation**: Meaning that this loan was acquired from the customers own inventory. * **interlibrary_loan**: Meaning that this loan was acquired as a interlibrary loan. * **unknown**: Meaning that this information is unknown.

PatronLoanAcquiredFromTypeInterlibraryLoan

typepåkrevd

string enuminterlibrary_loan

PatronLoanAcquiredFromTypeLocalCirculation

typepåkrevd

string enumlocal_circulation

PatronLoanAcquiredFromTypeUnknown

typepåkrevd

string enumunknown

PatronLoanHistory

idpåkrevd

string

This is the loan history ID (not the loan ID).

loanId

LoanId

publicationIdpåkrevd

LoanPublicationId

itemId

LoanItemId

checkoutTime

LoanCreatedTime

checkinTime

string (date-time)

The date and time the loan was checkin.

dueDate

string (date)

The due date of the loan at the time of checkin.

addedToHistoryTimepåkrevd

string (date-time)

The date and time when the loan was added to the patron loan history.

manuallyAddedpåkrevd

boolean

Was the loan added manually by the patron.

acquiredFrom

PatronLoanAcquiredFrom

publicationMetadata

PublicationFallback

PatronReservation

idpåkrevd

ReservationId

publicationIdpåkrevd

ReservationPublicationId

createdTimepåkrevd

ReservationCreatedTime

expirationDate

ReservationExpirationDate

statepåkrevd

ReservationState

fulfillmentBy

PatronReservationFulfillmentBy

pickuppåkrevd

object

queueNumber

ReservationQueueNumber

itemId

ReservationItemId

publicationMetadata

PublicationFallback

PatronReservationFulfillmentBy

This tells from where the material that are expected to fulfill this reservation will be acquired from. If this field are missing, the default value **local_circulation** should be assumed. * **local_circulation**: (default) Meaning that this reservation will be fulfilling from the customers own inventory. * **interlibrary_loan**: Meaning that this reservation will be fulfilled as a interlibrary loan. * **purchase**: Meaning that reservation can not be fulfilled right away, but a request to purchase the material has been submitted. * **unknown**: Meaning that this information is unknown.

PatronReservationFulfillmentByTypeInterlibraryLoan

typepåkrevd

string enuminterlibrary_loan

PatronReservationFulfillmentByTypeLocalCirculation

typepåkrevd

string enumlocal_circulation

PatronReservationFulfillmentByTypePurchase

typepåkrevd

string enumpurchase

PatronReservationFulfillmentByTypeUnknown

typepåkrevd

string enumunknown

PickupLocation

The object tells a location where a reservation item can be picked up. The `sections` is for specifying the location more precisely. The branch name and section names are included in the response to make it easier to display the location. They are the same values as from the /locations endpoint.

branchIdpåkrevd

string

The branch ID where a reservation should be picked up.

branchNamepåkrevd

string

This is the name of the branch.

sections

array of LocationSectionElementWithIdNameAndType

This are specifying the location more precisely.

Publication

identifierpåkrevd

PublicationIdentifier

workspåkrevd

array of PublicationWork

additionalIdentifiers

PublicationAdditionalIdentifiers

titlespåkrevd

PublicationTitles

creators

PublicationCreators

contributors

PublicationContributors

mediaTypes

PublicationMediaTypes

language

PublicationLanguage

edition

Edition

extent

PublicationExtent

publicationDate

Date

Date of publication.

publishers

array of PublisherAndPlaces

List of publishers and associated place(s) of publication.

binding

Binding

images

PublicationImages

PublicationAdditionalIdentifiers

Other identifiers, like: ISBN, ISSN, ...

PublicationContributors

The contributor(s) to the publication.

PublicationCreators

The creator(s) of the publication.

PublicationExtent

Together all the Extents in the array describes the total extent of the publication.

PublicationFallback

This metadata is only intended as fallback data, for when the provider is not able to serve the metadata through the GET /publication endpoint. This can for some provider be the case when working with e.g. interlibrary loans.

PublicationIdentifier

Publication identifier. This is searchable through the GET /publication endpoint.

PublicationImages

Images to use with the publication.

PublicationLanguage

This is the language(s) of the this publication. If the publication uses multi languages this will also contain them.

PublicationMediaTypes

PublicationTitles

Title of the publication.

PublicationWork

identifierpåkrevd

PublicationWorkIdentifier

relation

PublicationWorkRelation

PublicationWorkIdentifier

Work identifier of this publication. This is searchable through the GET /work endpoint.

PublicationWorkRelation

Describes the publications relation to a work. - contains: The publication contains this work, meaning the work is part of the publication. - embodies: The publication embodies this work, meaning the publication is the entire work.

Publisher

id

string

The unique identifier of the publisher. It can be used to search for the other entries by the publisher

namepåkrevd

string

The publisher's name.

PublisherAndPlaces

publisherpåkrevd

Publisher

places

array of PublisherPlace

Place of publication. Usually one place, but can be multiple.

PublisherPlace

placepåkrevd

string

ReservationCreatedTime

The date and time the reservation was created.

ReservationExpirationDate

The date when the reservation expires. If this is missing, the value is unknown.

ReservationId

This is the reservation ID.

ReservationItemId

This is the item identifier that actually fulfills the reservation. This can often only be set when the reservation is ready for pickup. If the reservation is on item level, it can be set earlier.

ReservationPickupExpirationDate

The date for the last chance to pick up the reservation. If this is missing, the value is unknown.

ReservationPickupNote

This is the note that is used to tell the patron where to get the reservation. E.g. - a shelf number, e.g. "Shelf 9". - an instruction, e.g. "Front desk" - an identifier, e.g. "10/114"

ReservationPublicationId

This is the publication ID of the reservation. If this is empty, the publication is unknown.

ReservationQueueNumber

The queue number tells what number in the queue the patron is. If this is missing, it represents that the queue number is unknown.

ReservationState

This represents where in the acquiring process this reservation is.

Title

TitleTypeOriginal

TitleTypeParallel

TitleTypePreferred

TitleTypeVariant

Version

Open Library API version.