/content/event Get content events
Retrieves a list of planned events with complete information. Returns full event representations suitable for detailed views.
Either to_date or event_ids must be included in a request.
If ui_language is not set, all languages are return.
Eksempel på kald
cURL
curl -X GET "$PLAS_BASE_URL/content/event?version=0.6.7" \
-H 'Accept: application/json' \
-H "Authorization: Bearer $PLAS_TOKEN"JavaScript
const response = await fetch(`${process.env.PLAS_BASE_URL}/content/event?version=0.6.7`, {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": `Bearer ${process.env.PLAS_TOKEN}`,
},
});
const data = await response.json();Python
import os
import requests
response = requests.get(
f"{os.environ['PLAS_BASE_URL']}/content/event",
params={
"version": "0.6.7",
},
headers={
"Accept": "application/json",
"Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
},
)
data = response.json()PLAS_BASE_URL providerens adresse · PLAS_TOKEN et access token.
Parametre
- page
- query · integerEksempel: 1
Page number for pagination.
- size
- query · integerEksempel: 10
Maximum number of events to return.
- from_date
- query · string (date)Eksempel: 2023-03-08
Inclusive start date in YYYY-MM-DD format. If omitted, the server will use the current date in its local timezone (e.g., CET) as the default
- to_date
- query · string (date)Eksempel: 2023-06-08
Inclusive end date.
- event_ids
- query · array of stringEksempel: 84410
The event ids should be url encoded and separated by a comma (the comma should not be url encoded).
Svar
200 Success GetContentEventsResponseBody
Eksempel
{
"endOfResults": false,
"events": [
{
"admission": {
"type": "open"
},
"audiences": [
{
"id": "94549",
"label": "Children"
}
],
"branch": {
"branchId": "nordby-main",
"branchName": "Nordby Main Library"
},
"categories": [
{
"id": "94549",
"label": "Education"
}
],
"description": "An evening about how Norwegian crime fiction found readers all over the world.",
"id": "94549",
"images": [
{
"height": 1200,
"mime": "png",
"url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
"width": 800,
"alt": {
"text": "Your reservation is ready for pickup."
},
"caption": "Front cover",
"credit": {
"text": "Your reservation is ready for pickup."
},
"original": {
"height": 1200,
"mime": "png",
"url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
"width": 800,
"focalPoints": [
{
"type": "hotspot",
"x": 0.5,
"y": 0.5
}
]
},
"type": "content"
}
],
"language": "nob",
"location": {
"location": "Auditorium, 2nd floor",
"type": "at_branch"
},
"organizers": [
{
"id": "94549",
"name": "Kari Nordmann"
}
],
"promoted": {
"endTime": "2025-01-25T12:00:00+01:00",
"startTime": "2025-01-25T11:00:00+01:00",
"type": "promoted"
},
"relatedEvents": [
"84411"
],
"relevantWorks": {
"type": "works",
"workIds": [
"882107"
]
},
"scheduling": {
"endDate": "2025-01-25",
"startDate": "2025-01-25",
"type": "all_day"
},
"series": {
"eventIds": [
"84410"
],
"seriesId": "3120"
},
"state": "scheduled",
"teaser": "Join us for an evening about Norwegian crime fiction.",
"title": "Author talk: Norwegian crime fiction",
"updateTime": "2025-01-25T11:00:00+01:00",
"url": "https://nordby.bibliotek.example/events/84410"
}
],
"total": 12
}Skema
- endOfResultsbooleanpåkrævet
If 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.
Vis 20 felterSkjul 20 felter
Admission and registration information for an event
Vis 3 varianterSkjul 3 varianter
Vælges af feltet type
- audiencesarray of EventAudience
Target audiences for the event
Vis 2 felterSkjul 2 felter
- idstringpåkrævet
Unique identifier for the audience target
- labelstringpåkrævet
Localized label for the audience target
Vis 2 felterSkjul 2 felter
- branchIdstringpåkrævet
The branch ID (should exist in GET /locations)
- branchNamestringpåkrævet
Name of the branch
- categoriesarray of EventCategory
Event categories
Vis 2 felterSkjul 2 felter
- idstringpåkrævet
Category identifier
- labelstringpåkrævet
Localized category label
- descriptionstringpåkrævet
A detailed description of the event. Is in limited html format. Supports following html tags - b - i - p - a - ul - ol - li
- idstringpåkrævet
Unique identifier for the event.
If multi events have the same 'id' but different language, then they are the same event.
Vis 9 felterSkjul 9 felter
- heightinteger
The image height in px.
- mimestring
Én af: png · jpeg
- urlstringpåkrævet
- widthinteger
The image width in px.
- altImageAlt
- captionstring
A short human-readable description of what the image shows.
- creditImageCredit
- originalImageOriginal
- typestringpåkrævet
Én af: content
- languagestring
The language of this events content (https://www.loc.gov/marc/languages/).
- locationEventLocation
The location where the event takes place
Vis 2 varianterSkjul 2 varianter
Vælges af feltet type
- organizersarray of EventOrganizer
Event organizers
Vis 2 felterSkjul 2 felter
- idstring
Unique identifier for the external organizer
- namestringpåkrævet
Name of the external organizer
- promotedPromoted
Vis 3 felterSkjul 3 felter
- endTimestring (date-time)
End time in RFC3339 date-time format.
- startTimestring (date-time)
Start time in RFC3339 date-time format.
Én af: promoted
- relatedEventsarray of string
Related events
- relevantWorksRelevantWorks
Books or other works relevant to the event
Vis 2 varianterSkjul 2 varianter
Vælges af feltet type
Vis 2 varianterSkjul 2 varianter
Vælges af feltet type
- seriesEventSeries
Vis 2 felterSkjul 2 felter
- eventIdsarray of string
An 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. - seriesIdstringpåkrævet
Identifier of the event-series. This searchId can be used with
GET /content/event/series/{seriesId}.
- statestringpåkrævet
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.
Én af: scheduled · cancelled · finished
- teaserstring
A short, engaging text designed to spark interest in the event
- titlestringpåkrævet
Event title
- updateTimestring (date-time)påkrævet
When was the event last update (or create) in RFC3339 date-time format.
- urlstring (uri)
URL to the event's webpage
- totalinteger
The total number of events in the whole period.
400 The list of errors. Errors
Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.
Eksempel
{
"errors": [
{
"code": 200103,
"info": "200103: invalid/unsupported query parameter value"
}
]
}Skema
The first error should always be the most relevant.
Vis 2 felterSkjul 2 felter
- codeintegerpåkrævet
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 identifier, password or pin code
- 100011: New password or pin code rejected, because it does not meet the provider's requirements
- 100013: The provider does not let the patron change the given credential
- 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
Én af: 500 · 600 · 10001 · 71001 · 100001 · 100011 · 100013 · 100023 · 100101 · 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
- infostringpåkrævet
Starts with the text matching the error code field (defined above), and a describing text could be added.
401 Bearer token invalid, missing, or expired.
Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.
Intet indhold i svaret.