Julkaisutietopalvelun tietoja voi hakea julkisen REST-rajapinnan kautta. Rajapintaa pääsee käyttämään ilmoittamalla teknisen yhteyshenkilön yhteystiedot (nimi, organisaatio, sähköposti ja puhelin) ja IP-osoitteen, josta rajapintaa haluaa käyttää sähköpostiosoitteeseen virta-julkaisut@postit.csc.fi
Rajapinta tarjoaa työkalut julkaisujen etsimiseen eri hakukriteerien perusteella, sekä yksittäisen, että useamman julkaisun hakemiseen. Julkaisut ovat saatavilla sekä JSON että XML (Julkaisu-XML) muodossa.
Hakutulokset paluttavat JSON muodossa suppeamman tietojouokon, jossa on vain osa julkaisujen perustiedoista. Nämä tiedot ovat julkaisunTunnus, julkaisunNimi, tekijat, julkaisuVuosi, lehdenNimi, issn, muutospvm ja julkaisunTila. Hakutulokset saa myös XML-muodossa, jolloin palautuvat kaikki tiedot. Katso hakuesimerkit ohjeen loppupuolelta.
Hakuparametrit
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| etunimi | query | no | Organisaation tekijän etunimet (vapaa tekstihaku) | - | string |
| sukunimi | query | no | Organisaation tekijän sukunimi (vapaa tekstihaku) | - | string |
| julkaisunNimi | query | no | Julkaisun nimi (vapaa tekstihak) | - | string |
| lehdenNimi | query | no | lehden nimi (vapaa tekstihaku) | - | string |
| julkaisuVuosi | query | no | JulkaisuVuosi | - | string |
| organisaatioTunnus | query | no | Organisaatiotunnus | - | string |
| orcid | query | no | ORCID -tunniste | - | string |
| julkaisuTyyppi | query | no | Julkaisun tyyppikoodi | - | string |
| julkaisunTila | query | no | julkaisun tilakoodi | - | string |
| issn | query | no | ISSN | - | string |
| isbn | query | no | ISBN | - | string |
| kustantajanNimi | query | no | Kustantajan nimi | - | string |
Julkaisutietovarannon rajapinta - hakuesimerkkejä
Yksittäisen julkaisun hakeminen rajapinnasta XML ja JSON muodossa
# curl -k -i -H "Accept: application/xml" https://dwitjutife1.csc.fi/api/julkaisut/xml/000051414
# curl -k -i -H "Accept: application/json" https://dwitjutife1.csc.fi/api/julkaisut/000051414
Useamman julkaisun tieojen hakeminen. Haetaan lehden nimen ja organisaatiotunnuksen mukaan (XML ja JSON (julkaisusjen perustiedot)).
Esimerkissä lehtenä on Suomen lääkärilehti nimi URL enkoodattuna.
# curl -k -i -H "Accept: application/xml" https://dwitjutife1.csc.fi/api/julkaisut/haku/xml?lehdenNimi=Suomen%20L%C3%A4%C3%A4k%C3%A4rilehti&organisaatioTunnus=01901
# curl -k -i -H "Accept: application/json" https://dwitjutife1.csc.fi/api/julkaisut/haku?lehdenNimi=Suomen%20L%C3%A4%C3%A4k%C3%A4rilehti&organisaatioTunnus=01901
Haettavien julkaisujen rajaaminen julkaisutyypin perusteelle. Muut hakuehdot: Lehti: ”Suomen Lääkärilehti” ja Organisaatio on 01901
# curl -k -i -H "Accept: application/json" https://dwitjutife1.csc.fi/api/julkaisut/haku?lehdenNimi=Suomen%20L%C3%A4%C3%A4k%C3%A4rilehti&julkaisuTyyppi=A1
# curl -k -i -H "Accept: application/json" https://dwitjutife1.csc.fi/api/julkaisut/haku?julkaisuVuosi=2014&organisaatioTunnus=01901
Esimerkkivastauksia
Yksittäisen julkaisun tiedot XML-muodossa:
Yksittäisen julkaisun tiedot JSON-muodossa:
Hakutulokset JSON-muodossa: