Agent

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

Get agents

Bearer-token GetAgents

Eksempel på kall

cURL

curl -X GET "$PLAS_BASE_URL/agent?agent_ids=agent-4102&version=0.6.4" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/agent?agent_ids=agent-4102&version=0.6.4`, {
  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']}/agent",
    params={
        "agent_ids": "agent-4102",
        "version": "0.6.4",
    },
    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

agent_idspåkrevd: query · array of string
A list of agent IDs, agent IDs should be url encoded and separated by a comma.
That means that, if you have e.g. three agent IDs "agent-123", "agent-456,abcd" and "789101112", they should be sent as: "agent_ids=agent-123,agent-456%2Cabcd,789101112".
Eksempel: agent-4102

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

Svar

200 Success GetAgentsResponseBody

Generert fra skjemaet

Eksempel

{
  "agents": {
    "agent-4102": {
      "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"
    }
  }
}

Skjema

GetAgentsResponseBody

agentsmap of Agentpåkrevd
Vis 1 feltSkjul 1 felt
- vilkårlig nøkkelAgent
  Vis 2 varianterSkjul 2 varianter
  Velges av feltet type
  Variant: person
  AgentTypePerson
  Se AgentTypePerson i skjemaindeksen
  Variant: collective
  AgentTypeCollective
  Se AgentTypeCollective 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 /agent/search

Search Agents

Bearer-token SearchAgents

Eksempel på kall

cURL

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

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/agent/search?version=0.6.4`, {
  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']}/agent/search",
    params={
        "version": "0.6.4",
    },
    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
Search agents.
Eksempel: undset
page: query · integer
Page number (default 1).
Eksempel: 1
size: query · integer
Page size (default 10).
Eksempel: 10
types: query · array of string
List of agents types allowed in result.
Eksempel: person

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

Svar

200 Success SearchAgentsResponseBody

Generert fra skjemaet

Eksempel

{
  "results": [
    {
      "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"
    }
  ],
  "total": 12
}

Skjema

SearchAgentsResponseBody

resultsarray of Agentpåkrevd
Vis 2 varianterSkjul 2 varianter
Velges av feltet type
Variant: person
AgentTypePerson
descriptionstring
This is a description of the agent.
fullNamestringpåkrevd
This is the full name of the agent.
idstring
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.
imagesarray of ImageAgent
Images of the agent.
Se ImageAgent i skjemaindeksen
activeone of AgentPersonActiveLiteral
birthDateDate
Se Date i skjemaindeksen
deathDateDate
Se Date i skjemaindeksen
externalsobject
These are external references outside Open Library API.
givenNamestring
surnamestring
typestringpåkrevd
Én av: person
Variant: collective
AgentTypeCollective
descriptionstring
This is a description of the agent.
fullNamestringpåkrevd
This is the full name of the agent.
idstring
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.
imagesarray of ImageAgent
Images of the agent.
Se ImageAgent i skjemaindeksen
typestringpåkrevd
Én av: collective
totalintegerpåkrevd
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.