Skemaer

Vis som Markdown Sidens .md-fil llms.txt Alle sider, til AI-værktøjer Åbn i ChatGPT Stil spørgsmål om siden Åbn i Claude Stil spørgsmål om siden

Hvert navngivet skema i specifikationen, ét niveau dybt. Et felt der peger på et andet skema linker til det i stedet for at blive foldet ud, så hvert skema er beskrevet ét sted.

147 skemaer · Genereret fra search_v0_6_6.yaml Hvert felt står som navn, derefter type, derefter beskrivelse. En type der navngiver et andet skema linker til det.

AdditionalIdentifier

one of AdditionalIdentifierTypeISBN | AdditionalIdentifierTypeISSN | AdditionalIdentifierTypeEAN | AdditionalIdentifierTypeBibsentBibbi

AdditionalIdentifierTypeBibsentBibbi

typepåkrævet: string enumbibsentBibbi
valuepåkrævet: string

AdditionalIdentifierTypeEAN

digitspåkrævet: string enum13
typepåkrævet: string enumean
valuepåkrævet: string

AdditionalIdentifierTypeISBN

digitspåkrævet: string enum10 · 13
typepåkrævet: string enumisbn
valuepåkrævet: string

AdditionalIdentifierTypeISSN

typepåkrævet: string enumissn
valuepåkrævet: string

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.

typepåkrævet: string enumliteral
valuepåkrævet: string

AgentRole

one of AgentRoleMarcRelator

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

AgentRoleMarcRelator

roleCodepåkrævet: string
A contribution role code from the MARC Code List for Relators.
typepåkrævet: string enummarcRelator
Identifies the role code as being part of MARC Code List for Relators.

AgentTypeCollective

all of BaseAgent + object

AgentTypePerson

all of BaseAgent + object

Audience

one of AudienceTypeLiteral | AudienceTypeAgeRange | AudienceTypeAgeGroup

AudienceTypeAgeGroup

codepåkrævet: AudienceTypeAgeGroupCode
name: string
A displayable (human readable) audience group name.
typepåkrævet: 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: string
A 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
typepåkrævet: string enumageRange

AudienceTypeLiteral

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

code: string
A code that (if set) can be used with the filter plas.audience.literal to search on this audience literal.
typepåkrævet: string enumliteral
valuepåkrævet: string
A displayable (human readable) audience literal.

BaseAgent

description

string

This is a description of the agent.

fullNamepåkrævet

string

This is the full name of the agent.

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.

images

array of ImageAgent

Images of the agent.

BaseSuggestionAgent

fullNamepåkrævet: string
This is the full name of the agent.
id: string
This isn't required, but if it's set, the agent is searchable through the GET /agent endpoint.
images: array of ImageAgent
Images of the agent.

BasicTitle

language: Language
The language of the titles in the object.
mainpåkrævet: string
This is the main title.
part: object
This contains the information to distinguish the work.
remainder: string
This is the remainder of the title.

Binding

one of BindingTypeLiteral

BindingTypeLiteral

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

typepåkrævet: string enumliteral
valuepåkrævet: string
A displayable (human readable) representation of the binding.

Classification

one of ClassificationTypeDewey | ClassificationTypeDK5

ClassificationTypeDewey

name: string
A displayable (human readable) value representation of the dewey number.
numberpåkrævet: string
The value of the dewey number.
typepåkrævet: string enumdewey

ClassificationTypeDK5

name: string
A displayable (human readable) value representation of the dewey number.
numberpåkrævet: string
The value of the dk5 number.
typepåkrævet: string enumdk5

ConfigurationSearchExpression

clustering: array of array of ExpressionClusteringField
This 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: object
This 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 ConfigurationSearchSuggestionsFilterAvailable
This tells which filters are available for the /suggestions endpoint.
disabled: boolean
This 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: string
This is a description of what type of filter this is.
typepåkrævet: SuggestionsFilterType

ConfigurationWorkSearchFacet

available: array of ConfigurationWorkSearchFacetAvailable

ConfigurationWorkSearchFacetAvailable

description: string
This is a description of what type of facet this is.
typepåkrævet: SearchFacetType

ConfigurationWorkSearchFilter

available: array of ConfigurationWorkSearchFilterAvailable

ConfigurationWorkSearchFilterAvailable

description: string
This is a description of what type of filter this is.
typepåkrævet: SearchFilterType

ConfigurationWorkSearchSorting

available: array of ConfigurationWorkSearchSortingAvailable

ConfigurationWorkSearchSortingAvailable

This is a description of a sorting type.

description: string
This is a description of what type of sorting this is.
typepåkrævet: SearchSortingType

Contributor

agentpåkrævet: Agent
roles: array of AgentRole
List of roles (e.g. author, illustrator, editor) that the agent played in the creation of this entity.

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: boolean
The default value is false, meaning common era, otherwise before the common era.
centurypåkrævet: integer
The century e.g. 19 century CE (meaning 1801 CE to 1900 CE), 3 century BCE (meaning 300 BCE to 201 BCE)
typepåkrævet: string enumcentury

DateTypeLiteral

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

typepåkrævet: string enumliteral
valuepåkrævet: string

DateTypeRFC3339

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

datepåkrævet: string (date)
RFC3339 full-date format (YYYY-MM-DD).
typepåkrævet: string enumrfc3339

DateTypeYear

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

typepåkrævet: string enumyear
yearpåkrævet: 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.

from: integer
Eg. 1924
to: integer
Eg. 1979
typepåkrævet: string enumyearRange

Description

one of DescriptionTypeLiteral

DescriptionTypeLiteral

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

typepåkrævet: string enumliteral
valuepåkrævet: string

Edition

one of EditionTypeLiteral | EditionTypeNumbering

EditionTypeLiteral

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

typepåkrævet: string enumliteral
valuepåkrævet: string
A displayable (human readable) representation of the edition.

EditionTypeNumbering

display: string
A displayable (human readable) representation of the edition.
numberpåkrævet: integer
The edition number.
printing: integer
The printing number of the edition.
typepåkrævet: string enumnumbering

Error

codepåkrævet: ErrorCode
infopåkrævet: 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 - 100101: Patron could not be deleted, because the patron has something unresolved issue with the library (this could be anything from a loan to a fee, and so on ...) - 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

errorspåkrævet: array of Error
The first error should always be the most relevant.

ExpressionClusteringField

one of ExpressionClusteringFieldNamedCreators | ExpressionClusteringFieldNamedContributors | ExpressionClusteringFieldNamedCreatorsAndContributors | ExpressionClusteringFieldNamedMediaTypes | ExpressionClusteringFieldNamedLanguage