Work

Vis som Markdown Sidens .md-fil llms.txt Alle sider, for AI-verktøy Åpne i ChatGPT Still spørsmål om siden Åpne i Claude Still spørsmål om siden

Ingen beskrivelse i spesifikasjonen.

2 operasjoner

GET /work

Get Works

Bearer-token GetWorks

Eksempel på kall

cURL

curl -X GET "$PLAS_BASE_URL/work?work_ids=882107&version=0.6.3" \
  -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.3`, {
  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.3",
    },
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
)
data = response.json()

Verten og tokenet er miljøvariabler: PLAS_BASE_URL providerens adresse · PLAS_TOKEN et access token.

Parametere

work_idspåkrevd: query · array of string
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".
Eksempel: 882107

Felles for operasjonene: ui_language, version. Se den felles kontrakten på versjonssiden.

Svar

200 Success GetWorksResponseBody

Generert fra skjemaet

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

GetWorksResponseBody

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.
    Se WorkAudience i skjemaindeksen
  - classificationarray of Classification
    Classification of the work.
    Se WorkClassification i skjemaindeksen
  - contributorsarray of Contributor
    The contributor(s) to the work.
    Se WorkContributors i skjemaindeksen
  - creationDateDate
    Se Date i skjemaindeksen
  - creatorsarray of Contributor
    The creator(s) of the work.
    Se WorkCreators i skjemaindeksen
  - descriptionarray of Description
    Help readers understand what the work is about and whether they might be interested in lending/reserving it.
    Se WorkDescription i skjemaindeksen
  - formsarray of Form
    Form is a more specific type of metadata that describes the physical structure or organization of a work.
    Se WorkForms i skjemaindeksen
  - genresarray of Genre
    Genre is a broad category of works that share similar characteristics, such as style, tone, or subject matter.
    Se WorkGenres i skjemaindeksen
  - identifierstringpåkrevd
    Work identifier. This is searchable through the GET /work endpoint.
  - imagesarray of ImagePublication
    Images to use with the work.
    Se WorkImages i skjemaindeksen
  - 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.
    Se WorkLanguage i skjemaindeksen
  - 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.
    Se WorkSubjects i skjemaindeksen
  - titlesarray of Titlepåkrevdmin. antall 1
    Title of the work.
    Se WorkTitles i skjemaindeksen

400 The list of errors. Errors

Felles svar, definert én gang for hele API-et. Se den felles kontrakten på versjonssiden.

Generert fra skjemaet

Eksempel

{
  "errors": [
    {
      "code": 200103,
      "info": "200103: invalid/unsupported query parameter value"
    }
  ]
}

Skjema

Errors

errorsarray of Errorpåkrevdmin. antall 1
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
  - 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.

GET /work/search

Search Works

Bearer-token SearchWorks

Search the metadata and returns with a list of works.

It’s expected that the fields that are arrays in the search result are sorted that same way in /work and /publication.

Filters:

plas.audience.literal (work)
plas.audience.ageRange (work)
plas.audience.ageGroup (work)
plas.mediaTypes (publication)
plas.language (work and publication)
plas.subjects (work)
plas.genres (work)
plas.forms (work)
plas.agent (work)

Facets:
All facets should also exist (with the same name) as an filter.

plas.audience.literal
plas.audience.ageRange
plas.audience.ageGroup
plas.mediaTypes
plas.language
plas.subjects
plas.genres
plas.forms
plas.agent

Sorting:

plas.relevance.asc
plas.relevance.desc (default)
plas.titles.asc
plas.titles.desc
plas.publicationDate.asc
plas.publicationDate.desc

Eksempel på kall

cURL

curl -X GET "$PLAS_BASE_URL/work/search?version=0.6.3" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/work/search?version=0.6.3`, {
  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/search",
    params={
        "version": "0.6.3",
    },
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
)
data = response.json()

Verten og tokenet er miljøvariabler: PLAS_BASE_URL providerens adresse · PLAS_TOKEN et access token.

Parametere

query: query · string
The search query.
Eksempel: undset
page: query · integer
Page number (default 1).
Eksempel: 1
size: query · integer
Page size (default 10). It's important to be aware that, the page size here is only a preferred page size, the result set can be both small and greater, depending on the implementation from the LMS provider. This is important to consider in any product design.
Eksempel: 10
facet: query · array of SearchFacetType
Return these facets.
Eksempel: plas.audience.literal
facet_terms_size: query · integer
Return this number of facet terms for each requested facet (default 10).
Eksempel: 10
sort: query · SearchSortingType
Sorting
Eksempel: plas.relevance.asc
filter: query · map of string
The individual filter values are OR'ed together, and the filter are then AND'ed together. The hole statement will be AND'ed with the given query.
Eg. filter[plas.mediaTypes]=book,cd&filter[plas.subjects]=dance will be made into plas.mediaTypes=(book OR cd) AND plas.subjects=dance
The possible keys in this map are the filters defined in the /configuration(/search) endpoint (field: (search->)workSearch->filter->available) and are the list of strings of the SearchFilterType type.
Eksempel: {"filter-1":"Example filter"}

Felles for operasjonene: ui_language, version. Se den felles kontrakten på versjonssiden.

Svar

200 Success SearchWorksResponseBody

Generert fra skjemaet

Eksempel

{
  "endOfResults": false,
  "facets": [
    {
      "name": "Kari Nordmann",
      "terms": [
        {
          "name": "Kari Nordmann",
          "occurrences": 4,
          "value": "book"
        }
      ],
      "type": "plas.audience.literal"
    }
  ],
  "results": [
    {
      "work": {
        "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"
              }
            ]
          }
        ],
        "forms": [
          {
            "id": "94549",
            "label": "Novel"
          }
        ],
        "identifier": "882107",
        "images": [
          {
            "height": 1200,
            "mime": "png",
            "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
            "width": 800,
            "type": "frontCover"
          }
        ],
        "publications": [
          {
            "identifier": "310552",
            "language": [
              {
                "code": "SplxlOBeZQQYbYS6WxSbIA",
                "name": "Kari Nordmann"
              }
            ],
            "mediaTypes": [
              {
                "code": "book",
                "name": "Kari Nordmann"
              }
            ]
          }
        ],
        "titles": [
          {
            "language": {
              "code": "SplxlOBeZQQYbYS6WxSbIA",
              "name": "Kari Nordmann"
            },
            "main": "Kristin Lavransdatter",
            "part": {
              "name": "Kari Nordmann",
              "number": "1"
            },
            "remainder": "The Wreath",
            "type": "preferred"
          }
        ]
      }
    }
  ],
  "total": 12
}

Skjema

SearchWorksResponseBody

endOfResultsbooleanpåkrevd
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.
facetsarray of Facet
This array contains the requested facets, and their terms. Each facet type should only appear once in the array.
Vis 3 felterSkjul 3 felter
- namestring
  A displayable (human readable) facet name.
- termsarray of FacetTermpåkrevdmin. antall 1
  Vis 3 felterSkjul 3 felter
  - namestringpåkrevd
    A displayable (human readable) representation of facet term name.
  - occurrencesinteger
    The number of occurrences in the search result, based on works.
  - valuestringpåkrevd
    The facet terms searchable value.
- typeSearchFacetTypepåkrevd
  Facet type, this is the value given to the search facet parameter.
  The SearchFacetType should always exists in SearchFilterType
  Én av: plas.audience.literal · plas.audience.ageRange · plas.audience.ageGroup · plas.mediaTypes · plas.language · plas.subjects · plas.genres · plas.forms
  Vis 2 varianterSkjul 2 varianter
  Variant: SearchFacetTypeEnum
  SearchFacetTypeEnum
  Variant: SearchFacetTypeLiteral
  SearchFacetTypeLiteral
resultsarray of SearchResultEntrypåkrevd
It's important to be aware that, the result size doesn't always match the given page size, the result set can be both small and greater.
Vis 1 feltSkjul 1 felt
- workSearchResultEntryWorkpåkrevd
  Vis 7 felterSkjul 7 felter
  - creationDateDate
    Se Date i skjemaindeksen
  - creatorsarray of Contributor
    The creator(s) of the work.
    Se WorkCreators i skjemaindeksen
  - formsarray of Form
    Form is a more specific type of metadata that describes the physical structure or organization of a work.
    Se WorkForms i skjemaindeksen
  - identifierstringpåkrevd
    Work identifier. This is searchable through the GET /work endpoint.
  - imagesarray of ImagePublication
    Images to use with the work.
    Se ImagePublication i skjemaindeksen
  - publicationsarray of SearchResultEntryPublicationpåkrevdmin. antall 1
    This contain only the underlying publications from the work, that matches the search criteria.
    Se SearchResultEntryPublication i skjemaindeksen
  - titlesarray of Titlepåkrevdmin. antall 1
    Title of the work.
    Se WorkTitles i skjemaindeksen
totalinteger
The total number of results in the whole search result.

400 The list of errors. Errors

Felles svar, definert én gang for hele API-et. Se den felles kontrakten på versjonssiden.

Generert fra skjemaet

Eksempel

{
  "errors": [
    {
      "code": 200103,
      "info": "200103: invalid/unsupported query parameter value"
    }
  ]
}

Skjema

Errors

errorsarray of Errorpåkrevdmin. antall 1
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
  - 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.