Event — Vendor API v0.6.3

POST /events/receiver

Receives events from an LMS

Bearer-token ReceiverEvents

Eksempel på kald

cURL

curl -X POST "$PLAS_BASE_URL/events/receiver?version=0.6.3" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN" \
  -d '{
  "eventId": "84410",
  "type": "consent_changed",
  "data": {
    "consent": {
      "available": [
        {
          "type": "loan_history",
          "version": "2025-01"
        }
      ],
      "evaluated": [
        {
          "type": "loan_history",
          "given": true,
          "version": "2025-01"
        }
      ]
    },
    "patronId": "40218873"
  }
}'

JavaScript

const response = await fetch(`${process.env.PLAS_BASE_URL}/events/receiver?version=0.6.3`, {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.PLAS_TOKEN}`,
  },
  body: JSON.stringify({
    "eventId": "84410",
    "type": "consent_changed",
    "data": {
      "consent": {
        "available": [
          {
            "type": "loan_history",
            "version": "2025-01"
          }
        ],
        "evaluated": [
          {
            "type": "loan_history",
            "given": true,
            "version": "2025-01"
          }
        ]
      },
      "patronId": "40218873"
    }
  }),
});

Python

import os
import requests

response = requests.post(
    f"{os.environ['PLAS_BASE_URL']}/events/receiver",
    params={
        "version": "0.6.3",
    },
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
    json={
        "eventId": "84410",
        "type": "consent_changed",
        "data": {
            "consent": {
                "available": [
                    {
                        "type": "loan_history",
                        "version": "2025-01",
                    },
                ],
                "evaluated": [
                    {
                        "type": "loan_history",
                        "given": True,
                        "version": "2025-01",
                    },
                ],
            },
            "patronId": "40218873",
        },
    },
)
response.raise_for_status()

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

Parametre

Fælles for operationerne: version. Se den fælles kontrakt på versionssiden.

Request body

application/json · påkrævet · EventReceiverRequest

Vælges af feltet type

Variant: consent_changed

EventConsentChanged

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- consentPatronConsentpåkrævet
  Se PatronConsent i skema-indekset
- patronIdstringpåkrævet

Variant: patron_deleted

EventPatronDeleted

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 1 feltSkjul 1 felt
- patronIdstringpåkrævet

Variant: reservation_ready_for_pickup

EventReservationReadyForPickup

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- patronIdstring
- reservationPatronReservation
  Se PatronReservation i skema-indekset

Variant: ready_reservation_expires_soon

EventReadyReservationExpiresSoon

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- patronIdstring
- reservationPatronReservation
  Se PatronReservation i skema-indekset

Variant: reservation_expires_soon

EventReservationExpiresSoon

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- patronIdstring
- reservationPatronReservation
  Se PatronReservation i skema-indekset

Variant: reservation_reminder

EventReservationReminder

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- patronIdstring
- reservationPatronReservation
  Se PatronReservation i skema-indekset

Variant: loan_due_date_is_approaching

EventLoanDueDateIsApproaching

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- loanPatronLoan
  Se PatronLoan i skema-indekset
- patronIdstring

Variant: fee_due_date_is_approaching

EventFeeDueDateIsApproaching

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataobjectpåkrævet
Vis 2 felterSkjul 2 felter
- feePatronFee
  Se PatronFee i skema-indekset
- patronIdstring

Variant: item_checkout

EventItemCheckout

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataCheckoutResponseBodypåkrævet
Vis 5 felterSkjul 5 felter
- statusstringpåkrævet
  This tells the status of the checkout.
  The status are:
  - completed means that the checkout went well and was completed.
  - failed means that the checkout failed, and the item was not checked out.
  Én af: completed · failed
- acknowledgementobject
  If this is set, the checkout needs to be acknowledged to be completed.
- checkoutCheckoutFieldpåkrævet
  Se CheckoutField i skema-indekset
- messageCheckOutOrInMessage
  Se CheckOutOrInMessage i skema-indekset
- requestIdstringpåkrævet
  This is an unique identifier for the checkout request. This will change for each request.

Variant: item_checkin

EventItemCheckin

eventIdstringpåkrævet
A unique identifier for the event.
typeunknownpåkrævet
dataCheckinWithRequiredPatronIdResponseBodypåkrævet
Vis 5 felterSkjul 5 felter
- statusstringpåkrævet
  This tells the status of the checkin.
  The status are:
  - completed means that the checkin went well and was completed.
  - failed means that the checkin failed, and the item was not checked in.
  Én af: completed · failed
- completedboolean
  This tells if the checkin was completed or not. It is only true if the checkin was completed, else it is false.
- checkinCheckinFieldWithRequiredPatronIdpåkrævet
  Se CheckinFieldWithRequiredPatronId i skema-indekset
- messageCheckOutOrInMessage
  Se CheckOutOrInMessage i skema-indekset
- requestIdstringpåkrævet
  This is a unique identifier for the checkout request. This will change for each request.

Svar

204 OK

Intet indhold i svaret.

400 The list of errors. Errors

Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.

Genereret ud fra skemaet

Eksempel

{
  "errors": [
    {
      "code": 500,
      "info": "500: System error"
    }
  ]
}

Skema

Errors

errorsarray of Errorpåkrævetmin. antal 1
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</br>
  Én af: 500 · 600
- infostringpåkrævet
  Starts with the text matching the error code field (defined above), and a describing text could be added.

401 Secret is invalid.

Fælles svar, defineret én gang for hele API’et. Se den fælles kontrakt på versionssiden.

Intet indhold i svaret.