Autentisering: Krever OAuth 2.0 autentisering.
Legg inn en bestilling/reservering.
Tabell 1.5. Parametere
| Parameternavn | Forklaring |
|---|---|
| reservationPickUpBranch | Angir hvor låneren ønsker å hente det reserverte materialet. |
Eksempel 1.16. addReservation
Request:
https://faretbib.bib.no/rest_service/oawebapi_addReservation/1.0/data?reservationId=7980&oa_lnr_token=47cc56ac
https://faretbib.bib.no/rest_service/oawebapi_addReservation/1.0/data?reservationId=7980&reservationPickUpBranch=mbhv&oa_lnr_token=47cc56ac
Bruk reservationID=ix: og tnr,exnr for reservering av enkelteksemplar (aktuelt ved reservering av enkelthefter av periodika):
https://faretbib.bib.no/cgi-bin/rest_service/oawebapi_addReservation/1.0/data?reservationId=ix:314163,44
Respons:
{
"status" : true,
"message" : "",
"serverdate" : "2016-04-29T13:25:39"
}
For e-bøker (eBokBib) vil en slik bestilling bli effektuert umiddelbart/automatisk hvis det er ledige eksemplarer som låneren har tilgang til.
Brukes for å hente ut liste over og fjerne purregebyr på lånere. Denne bruker BasicAuthentication og skal ikke brukes igjennom nettleseren til låneren. Kan ikke brukes for å hente ut eller betale regninger.
Må aktiveres av Bibliotek-Systemer As før den kan brukes.
Tabell 1.6. Parametere
| Parameternavn | Forklaring |
|---|---|
| lnr | Lånernummeret til låneren |
| cmd | "list" for å hente ut liste over purregebyr, "pay" for å fjerne purregebyret |
| fee | Returnerer status=true hvis OK, ellers false med message satt. |
Eksempel 1.17. Bruk av fee
Purregebyr på låner 8:
https://faretbib.bib.no/cgi-bin/rest_service/webapi_fee/1.0/data/?lnr=8&cmd=list https://faretbib.bib.no/cgi-bin/rest_service/webapi_fee/1.0/data/?lnr=8&cmd=pay&fee=100
Respons:
{
"status" : true,
"message" : "",
"serverdate" : "2018-09-05T14:11:09",
"totalfee" : "100",
"fees" : [{
"bibliofilid" : "7438237",
"ordord" : "Khold",
"tittel" : "Hundre år gammal",
"material" : "lydopptak",
"titnr" : "288377",
"purreforfall" : "03/08/2018",
"bildeURL" : "http://krydder.bib.no/0835/7438237.bilde.1349603700.x.jpg"
}, {
"bibliofilid" : "9737658",
"ordord" : "Klougart, Josefine",
"tittel" : "En av oss sover",
"material" : "Bok",
"titnr" : "304446",
"purreforfall" : "04/08/2018",
"bildeURL" : "http://krydder.bib.no/0853/9737658.bilde.1358164291.x.jpg"
}, {
"bibliofilid" : "742367",
"ordord" : "Ullmann, Linn",
"tittel" : "Når jeg er hos deg : roman",
"material" : "Bok",
"titnr" : "262370",
"purreforfall" : "05/08/2018",
"bildeURL" : "http://krydder.bib.no/0136/742367.bilde.1327446119.x.jpg"
}]
}
Legg på tilfeldige purregebyr på låneren ved å gå til:
https://faretbib.bib.no/cgi-bin/privat/settpurring
(Kode=betalmedglede)
Fjern en eller flere reserveringer.
Eksempel 1.18. removeReservations
Request: https://faretbib.bib.no/rest_service/oawebapi_removeReservations/1.0/data?reservationIds=7980&oa_lnr_token=47cc56ac
Respons:
{
"status" : true,
"message" : "",
"serverdate" : "2016-04-29T13:28:04",
"detailed_status" : [{
"reservationId" : 7980,
"status" : true,
"message" : ""
}]
}
Liste over den innloggede lånerens lån.
Eksempel 1.19. getLoans
https://faretbib.bib.no/rest_service/oawebapi_getLoans/1.0/data
Respons:
User loan object:
{
loanId: string, // Til bruk ved fornyelser
localId: string,
dueDate: string, // ISO 8601
loanDate: string, // ISO 8601
loanBranch: string, // Hvor lånet er gjort
renewedToday: bool,
loanIsRenewable: bool,
loanIsFastTrack: bool,
readyForPickup: bool,
pickupReference: string,
pickupBranch: string,
pickupDueDate: string, // ISO 8601, til avhenting, hentefrist
title: string,
authors: string[],
…
}
https://faretbib.bib.no/rest_service/oawebapi_getLoans/1.0/data
"status" : true,
"message" : "",
"serverdate" : "2016-04-15T11:01:26",
"loans" : [{
"loanId" : "ix:101,2",
"authors" : "Såtvedt, Olav",
"title" : "Giftskandalen",
"dueDate" : "2016-02-01",
"isbn" : "8210029940",
"material" : "Bok",
"localId" : 101,
"bibliofilid" : 34963,
"loanDate" : "",
"renewedToday" : false,
"loanBranch" : "",
"loanIsRenewable" : true
"readyForPickup" : true,
"loanIsFastTrack" : false
"pickupReference" : "3\/ 10",
"pickupBranch" : "khbv",
"pickupDueDate" : "2018-05-07"
},{
"loanId" : "ix:202,1",
"authors" : "",
"title" : "Godt sagt : sitater, aforismer, visdomsord, ordspråk",
"dueDate" : "2016-05-13",
"isbn" : "8202117623",
"material" : "Bok",
"localId" : 202,
"bibliofilid" : 312848,
"loanDate" : "",
"renewedToday" : true,
"loanBranch" : "",
"loanIsRenewable" : true
"readyForPickup" : false,
"loanIsFastTrack" : false
"pickupReference" : "",
"pickupBranch" : "",
"pickupDueDate" : ""
},{
"loanId" : "ix:1009,10",
"authors" : "Golding, William",
"title" : "Fluenes herre",
"dueDate" : "2016-04-28",
"isbn" : "8205170304",
"material" : "Bok",
"localId" : 1009,
"bibliofilid" : 83207,
"loanDate" : "2016-03-31",
"renewedToday" : false,
"loanBranch" : "khbv",
"loanIsRenewable" : true
"readyForPickup" : true,
"loanIsFastTrack" : false
"pickupReference" : "1\/ 10",
"pickupBranch" : "khbv",
"pickupDueDate" : "2018-05-06"
},{
"loanId" : "ix:5003,3",
"authors" : "Ludlum, Robert",
"title" : "Gåten Jason Bourne : 2",
"dueDate" : "2016-05-13",
"isbn" : "82-590-0344-9",
"material" : "Bok",
"localId" : 5003,
"bibliofilid" : 1125048,
"loanDate" : "2016-03-31",
"renewedToday" : true,
"loanBranch" : "khbv",
"loanIsRenewable" : true
"readyForPickup" : false,
"loanIsFastTrack" : false
"pickupReference" : "",
"pickupBranch" : "",
"pickupDueDate" : ""
}]
}
Forny lån.
Tabell 1.7. Parametere
| Parameternavn | Forklaring |
|---|---|
| loanIds | loanIds skal være en liste med loanId fra getLoans separert med semikolon |
Returnerer: Et array med de lånene som er fornyet, evt. med status som forklarer problemer. Mulige problemer er: "Not on loan", "Not renewable", "Maximum loan period achieved", "Requested by another patron", "ILL not renewable".
Eksempel 1.20. renewLoans
https://faretbib.bib.no/rest_service/oawebapi_renewLoans/1.0/data?loanIds=ix:5003,3;ix:1007,2;ix:202,432
{
"status" : true,
"message" : "",
"serverdate" : "2016-04-15T11:02:47",
"renewstatus" : [{
"loanId" : "ix:5003,3",
"renewstatus" : true,
"renewmessage" : "",
"authors" : "Ludlum, Robert",
"title" : "Gåten Jason Bourne : 2",
"dueDate" : "2016-05-13",
"isbn" : "82-590-0344-9",
"material" : "Bok",
"localId" : 5003,
"bibliofilid" : 1125048,
"loanDate" : "2016-03-31",
"renewedToday" : true,
"loanBranch" : "khbv",
"loanIsRenewable" : true
},{
"loanId" : "ix:1007,2",
"renewstatus" : false,
"renewmessage" : "Not on loan"
},{
"loanId" : "ix:202,432",
"renewstatus" : false,
"renewmessage" : "loanId not found"
}]
}
Setter og fjerner obskoder på lånere. (Om obskoder, se https://bibsyst.no/web/ba2/obs_kd.html).
Tabell 1.8. Parametere
| Parameternavn | Forklaring |
|---|---|
| lnr | lånernummer |
| obs | mellomromseparert liste med obskoder som skal legges til eller slettes |
Eksempel 1.21. Obskoder
https://faretbib.bib.no/rest_service/webapi_obskode/1.0/data?lnr=10&obs=D
{
"status" : true,
"message" : "",
"serverdate" : "2016-09-15T16:23:55",
"obs" : "D"
}
Svaret i obs vil være aktive obskoder på låneren (uten mellomrom). For å fjerne obskoder brukes minus (Eks: -D). Obskode "D" brukes for å gi lånere tilgang til døgnåpent bibliotek. Obskode "B" brukes for å blokkere lånere og bør sjekkes før man eventuelt setter "D".
Autentisering: Krever Basic Authentication