/work Get Works
Eksempel på kall
cURL
curl -X GET "$PLAS_BASE_URL/work?work_ids=882107&version=0.6.6" \
-H 'Accept: application/json' \
-H "Authorization: Bearer $PLAS_TOKEN"JavaScript
const response = await fetch(`${process.env.PLAS_BASE_URL}/work?work_ids=882107&version=0.6.6`, {
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']}/work",
params={
"work_ids": "882107",
"version": "0.6.6",
},
headers={
"Accept": "application/json",
"Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
},
)
data = response.json()PLAS_BASE_URL providerens adresse · PLAS_TOKEN et access token.
Parametere
- work_idspåkrevd
- query · array of stringEksempel: 882107
A list of work IDs, work IDs should be url encoded and separated by a comma.
That means that, if you have e.g. three work IDs "work-123", "work-456,abcd" and "789101112", they should be sent as: "work_ids=work-123,work-456%2Cabcd,789101112".
Svar
200 Success GetWorksResponseBody
Eksempel
{
"works": {
"882107": {
"audience": [
{
"code": "SplxlOBeZQQYbYS6WxSbIA",
"type": "literal",
"value": "Adults"
}
],
"classification": [
{
"name": "Kari Nordmann",
"number": "839.8236",
"type": "dewey"
}
],
"contributors": [
{
"agent": {
"description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
"fullName": "Sigrid Undset",
"id": "agent-4102",
"images": [
{
"height": 1200,
"mime": "png",
"url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
"width": 800,
"type": "agent"
}
],
"active": {
"type": "literal",
"value": "1882-1949"
},
"birthDate": {
"type": "literal",
"value": "1920"
},
"deathDate": {
"type": "literal",
"value": "1920"
},
"externals": {
"identifiers": [
{
"type": "norwegianAuthorityFile",
"value": "4102"
}
]
},
"givenName": "Kari",
"surname": "Nordmann",
"type": "person"
},
"roles": [
{
"roleCode": "aut",
"type": "marcRelator"
}
]
}
],
"creationDate": {
"type": "literal",
"value": "1920"
},
"creators": [
{
"agent": {
"description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
"fullName": "Sigrid Undset",
"id": "agent-4102",
"images": [
{
"height": 1200,
"mime": "png",
"url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
"width": 800,
"type": "agent"
}
],
"active": {
"type": "literal",
"value": "1882-1949"
},
"birthDate": {
"type": "literal",
"value": "1920"
},
"deathDate": {
"type": "literal",
"value": "1920"
},
"externals": {
"identifiers": [
{
"type": "norwegianAuthorityFile",
"value": "4102"
}
]
},
"givenName": "Kari",
"surname": "Nordmann",
"type": "person"
},
"roles": [
{
"roleCode": "aut",
"type": "marcRelator"
}
]
}
],
"description": [
{
"type": "literal",
"value": "A historical novel in three parts, set in 14th-century Norway."
}
],
"forms": [
{
"id": "94549",
"label": "Novel"
}
],
"genres": [
{
"id": "94549",
"label": "Historical fiction"
}
],
"identifier": "882107",
"images": [
{
"height": 1200,
"mime": "png",
"url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
"width": 800,
"type": "frontCover"
}
],
"language": [
{
"code": "SplxlOBeZQQYbYS6WxSbIA",
"name": "Kari Nordmann"
}
],
"publicationIds": [
"41867"
],
"subjects": [
{
"id": "94549",
"label": "Middle Ages"
}
],
"titles": [
{
"language": {
"code": "SplxlOBeZQQYbYS6WxSbIA",
"name": "Kari Nordmann"
},
"main": "Kristin Lavransdatter",
"part": {
"name": "Kari Nordmann",
"number": "1"
},
"remainder": "The Wreath",
"type": "preferred"
}
]
}
}
}Skjema
- worksmap of Workpåkrevd
Vis 1 feltSkjul 1 felt
- vilkårlig nøkkelWork
Vis 14 felterSkjul 14 felter
- audiencearray of Audience
Intended audience, target audience or intellectual level of the work.
- classificationarray of Classification
Classification of the work.
- contributorsarray of Contributor
The contributor(s) to the work.
- creationDateDate
- creatorsarray of Contributor
The creator(s) of the work.
- descriptionarray of Description
Help readers understand what the work is about and whether they might be interested in lending/reserving it.
- formsarray of Form
Form is a more specific type of metadata that describes the physical structure or organization of a work.
- genresarray of Genre
Genre is a broad category of works that share similar characteristics, such as style, tone, or subject matter.
- identifierstringpåkrevd
Work identifier. This is searchable through the GET /work endpoint.
Images to use with the work.
- languagearray of Language
This is the original language of the work. If the original version of the work uses multi languages this will also contain them.
- publicationIdsarray of string
All publication identifiers from the works underlying publications. These are searchable through the GET /publication endpoint.
- subjectsarray of Subject
Subject is a topic or theme that is covered in a work.
Title of the work.
400 The list of errors. Errors
Felles svar, definert én gang for hele API-et. Se den felles kontrakten på versjonssiden.
Eksempel
{
"errors": [
{
"code": 200103,
"info": "200103: invalid/unsupported query parameter value"
}
]
}Skjema
The first error should always be the most relevant.
Vis 2 felterSkjul 2 felter
- codeintegerpåkrevd
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
Én av: 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
- infostringpåkrevd
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.
Felles svar, definert én gang for hele API-et. Se den felles kontrakten på versjonssiden.
Ikke noe innhold i svaret.
404 Resource not found.
Felles svar, definert én gang for hele API-et. Se den felles kontrakten på versjonssiden.
Ikke noe innhold i svaret.