...
| Code Block | ||
|---|---|---|
| ||
{
"lender_ids": ["614200"],
"query": {
"q": "(and title:'Snømannen' published_year:2011 authors:'Nesbø, Jo')",
"parser": "structured",
"size": 100,
"cursor": "initial"
}
} |
User related API endpoints
API endpoints specific for a user, all of these support national library card ID or local IDs as long as these are registered in allbok.
Begin a loan for a user
POST /loan
| Code Block | ||
|---|---|---|
| ||
{
user_id:"",
user_type: "",
isbn: ""
} |
Return a loan for a user
PUT /loan/{id}/return
Response on OK: 204
Check if book is available for loan
POST /content/status
Response on OK: 200
Check if one or more books are available for the given library, will return a list of ISBNs that are available (based on input list). If none of the given ISBNs are available, an empty list is returned.
| Code Block | ||
|---|---|---|
| ||
{
"lender_ids": [
"225544"
],
"content_ids": [
"9788245023282",
"9788242965271"
]
} |
Response will look like this if 9788245023282 was available.
| Code Block | ||
|---|---|---|
| ||
{
"items": [
"9788245023282"
]
} |
Get list of loans for user
GET /loans
Query params
...
param
...
id
...
user id
...
User ID can be local or national library card ID
...
type
...
This is the type of user ID given
...
See section User-ID types
...
lender_id
...
array of library ids
...
list of libraries to get loans for
Add book to queue for user
POST /queue
Response on OK: http 201
| Code Block | ||
|---|---|---|
| ||
{
user_id:"",
user_type: "",
isbn: ""
} |
Remove book from queue for user
DELETE /queue/{id}
Get list of books in queue for user
GET /queue
Returns a list of books that the user has queued for, list will include metadata on books.
| Code Block |
|---|
{
"queue_items": [{
"id": "1db1921b-f42a-4756-ae98-676176a56462",
"content_id": "9788202603076",
"metadata": {
"id": "9788202603076",
"title": "Om å skrive",
"description": "Hva er en god historie og hvordan fortelle den best mulig? Dette vil Hans Olav Brenner ha svar på når han samtaler med noen av Norges fremste forfattere om skrivehåndverket. Det er et litterært stjernelag han har fått med seg, som deler sine egne erfaringer om hvordan man skriver skjønnlitteratur. Om å skrive vil være til stor glede for forfattere, journalister og alle andre som skriver .- eller drømmer om å gjøre det.",
"authors": [{
"id": 707067,
"name": "Brenner, Hans Olav"
}],
"published_year": 2019,
"publishers": ["Cappelen Damm"],
"format": "EPUB",
"languages": ["bm"],
"languages_no": ["Bokmål"],
"image_url": "https://media.dev.boknett.cloud/objects/97/11/150301197/productimage_M1_c1d77cf3cde9f0881b4c355398f35919012d36c9.jpg",
"image_thumbnail_url": "https://media.dev.boknett.cloud/objects/97/11/150301197/productimage_M4_5fbb94f2f857a44fc029f3dd05100535fc959ad3.jpg",
"varegruppe": "Litterære tekster ebøker",
"bokgruppe": "Norsk sakprosa, voksne",
"gross_sales_price": 149.0,
"drm": "SDRM",
"available_text": "I salg",
"available": true,
"available_for_allvit": false,
"allvit_subjects": ["Annet"],
"thema_subject_no": ["Litteratur: historie og kritikk"],
"thema_geo_no": ["Norge"],
"ean": "9788202603076",
"edition": 1,
"in_sales_date": "2019-04-30T22:00:00Z",
"pages": 231,
"open_access": false,
"free_book": false,
"alternative_editions_eans": ["9788293110002", "9788202603069"],
"note": "Feil utgivelsesår i kolofonen: 2018",
"product_owner": "Cappelen Damm AS",
"product_owner_id": "0008"
},
"created": "2019-11-18T08:13:33",
"active": true
}, {
"id": "b1dcb7ee-dadd-4ad1-9e7f-7767a7c8771c",
"content_id": "9788202617813",
"metadata": {
"id": "9788202617813",
"title": "Gjeldsordningsloven : med kommentarer",
"description": " Gjeldsordningslovens formål er å gi privatpersoner med alvorlige gjeldsproblemer en mulighet til å gjenvinne kontrollen over sin økonomi. Denne boken inneholder forklarende kommentarer til alle lovens bestemmelser. I kommentarene er det henvist til lovens forarbeider, som illustrerer lovgivers intensjoner med loven, og utførlige henvisninger til rettsavgjørelser, som viser hvordan loven er tolket i praksis. Gjeldsordningsloven er endret flere ganger siden ikrafttredelsen 1. januar 2003. Lovendringene er kommentert med henvisning til de aktuelle lovforarbeidene og med beskrivelser av bakgrunnen for endringene. Målgruppen er i første rekke dommere, namsmenn og advokater som søker svar på hvordan loven er tolket i praksis. Boken er også nyttig for saksbehandlere i privat og offentlig virksomhet som kommer i befatning med gjeldsordningssaker, for kreditorer som blir omfattet av en gjeldsordning og for personer som søker om gjeldsordning. ",
"authors": [{
"id": 32989,
"name": "Moe, Ernst"
}],
"published_year": 2018,
"publishers": ["Cappelen Damm akademisk"],
"format": "EPUB",
"languages": ["bm"],
"languages_no": ["Bokmål"],
"image_url": "https://media.dev.boknett.cloud/objects/55/42/150304255/productimage_M1_e1a8eaf6a48b323fe4ed5058e321ab206fc4f2f9.jpg",
"image_thumbnail_url": "https://media.dev.boknett.cloud/objects/55/42/150304255/productimage_M4_bde536e8f8242975fb1370bc565e145dee5f148f.jpg",
"varegruppe": "Lover - særtrykk og forskrifter ebøker",
"bokgruppe": " Faglitteratur for profesjonsmarkedet",
"drm": "SDRM",
"available_text": "I salg",
"available": true,
"available_for_allvit": true,
"allvit_subjects": ["Jus"],
"thema_subject_no": ["Folkerett: økonomi og handel", "Rettskilder: lovgivning"],
"thema_geo_no": ["Norge"],
"ean": "9788202617813",
"edition": 1,
"in_sales_date": "2018-10-22T22:00:00Z",
"pages": 426,
"actors": [{
"name": "Norge",
"role": "EMPTY_VALUE"
}],
"open_access": false,
"free_book": false,
"alternative_editions_eans": ["9788202549282", "9788205364356"],
"product_owner": "Cappelen Damm AS",
"product_owner_id": "0008"
},
"created": "2019-11-01T10:14:17",
"active": true
}]
} |
Query params
...
param
...
id
...
user id
...
User ID can be local or national library card ID
...
type
...
This is the type of user ID given
...
See section User-ID types
...
lender_id
...
array of library ids
...
list of libraries to get loans for
User-ID types
The APIs supports multiple external user-IDs and one must defined which type you are sending when send a user-id in the id param.
...
Param value
...
Description
...
NATIONAL_LIBRARY_CARD_NUMBER
...
Norwegian national library card
...
FEIDE
...
Feide-ID
...
LOCAL_LIBRARY_CARD_NUMBER_MICROMARC
...
Local library card for libraries using Micromarc
...
LOCAL_LIBRARY_CARD_NUMBER_BIBLIOFIL
...
Local library card for libraries using Bibliofil