Luettelointirajapinnalla voi hakea ja muokata bibliografisia tietueita. Rajapinta on toteutettu HTTP REST arkkitehtuurimallilla.
Yhteysosoitteet
Testi
URL: http://libtest1.csc.fi:8992/API/
Protokollat: http
Tunnistautuminen
Toteutus on HTTP Basic Access autentikaation mukainen ja tapahtuu käyttäjätunnus-salasanaparilla. Käyttäjätunnukset voi tilata sähköpostitse osoitteesta [email protected].
GET-pyynnöt
GET-metodilla tehdyt pyynnöt eivät vaadi tunnistautumista.
Resurssit
/bib
Metodi | Kuvaus | Parametrit | Pyynnön sisältötyypit | Vastauksen sisältötyypit | Esimerkki |
---|---|---|---|---|---|
POST | Luo uusi tietue | check (boolean) : Tarkista sisällön oikeellisuus mutta älä tallenna sitä bypass_low_validation (boolean) : Tallenna tietue vaikka tallentajalla ei olisi käyttöoikeuksia kaikkiin LOW-kenttiin | text/xml | text/xml | POST /API/bib/ HTTP/1.1 HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 <response> <message>[0018] Document: 00XXXXXXX was updated successfully.</message> <session-id>XXXXXXXXXXXXXXXX</session-id> </response> |
/bib/:id
Metodi | Kuvaus | Parametrit | Pyynnön sisältötyypit | Vastauksen sisältötyypit | Esimerkki |
---|---|---|---|---|---|
GET | Hae tietue | text/xml | GET /API/bib/1234 HTTP/1.1 Host: libtest1.csc.fi:8992
Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="UTF-8"?> <record><leader>00000cam^a22002177i^4500</leader><controlfield tag="001">000001234</controlfield> ... | ||
PUT | Päivitä tietuetta | check (boolean) : Tarkista sisällön oikeellisuus mutta älä tallenna sitä bypass_low_validation (boolean) : Tallenna tietue vaikka tallentajalla ei olisi käyttöoikeuksia kaikkiin LOW-kenttiin | text/xml | text/xml | PUT /API/bib/1234 HTTP/1.1 HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 <response> <message>[0018] Document: 00XXXXXXX was updated successfully.</message> <session-id>XXXXXXXXXXXXXXXX</session-id> </response> |
/bib/:id/children
Metodi | Kuvaus | Parametrit | Pyynnön sisältötyypit | Vastauksen sisältötyypit | Esimerkki |
---|---|---|---|---|---|
GET | Hae tietueen osakohdetietueet | limit (number) : Palautettavien osakohteiden maksimäärä. Osakohteiden kokonaismäärä ilmoitetaan collection-elementin allRecordsCount-ominaisuudella. start (number) : Indeksi josta lähtien osakohteita palautetaan (Ensimmäisen osakohteen järjestysnumero on 0). Valittu järjestysnumero ilmoitetaan collection-elementin firstRecordNumber-ominaisuudella include_parent (boolean) : Palauta myös itse emotietue osakohteiden mukana | text/xml | GET /API/bib/1234/children HTTP/1.1 HTTP/1.1 200 OK
<collection allRecordsCount="0"> </collection> |
Parametrit
Parametrin tyyppi ilmoitetaan nimen perässä:
parametri (string): Merkkijonoparametri
Vapaaehtoiset parametrit on kursivoitu:
pakollinen (string) : Pakollinen parametri
vapaaehtoinen (boolean) : Vapaaehtoinen parametri