Brukerdokumentasjon Cristin Web Service Versjon 1.0

Transkript

1 Brukerdokumentasjon Cristin Web Service Versjon 1.0 Innledning Tjenesten er designet etter en RPC 1 modell over HTTP. Hver tjeneste er en funksjon som kjøres vha. GET og som tar parametere i form av query parameters. Svar blir levert i XML eller JSON format. Dersom tjenesten returnerer et bilde, blir det levert i JPEG format. Dersom et søk gir over 1000 treff ansees dette som en feilsituasjon. Man kan da begrense søket ytterligere og prøve igjen. Håndtering av feilsituasjoner HTTP feilkode Forklaring 400 En ugyldig parameterkombinasjon er angitt eller påkrevede parametere er utelatt. 404 Søket ga ingen treff 413 Søket er for vidt til at tjenesten kan returnere et svar En feil oppstod på serveren. Tjeneste 1: hentperson Tjenestene Tjenesten henter ut opplysninger om en person som er registert i Cristin. Personen kan angis enten med (bruker)navn og eierkode eller med lopenr. Basis URL: /ws/hentperson eierkode Streng Kode som identifiserer organisasjonen hvor brukernavnet hører hjemme. Må brukes sammen med parameteren navn. navn Streng Brukernavn tiknyttet en organisasjon. Må brukes sammen med parameteren eierkode. 1 Remote Procedure Call 2 Dette er strengt tatt feil bruk av denne koden, men ingen annen kode passer bedre

2 lopenr Heltall Unik id for en person i Cristinsystemet. Må ikke brukes sammen med parameterne navn og eierkode. format Streng Angir hva slags format man ønsker å få levert svaret på. Mulige verdier er xml og json. (valgfri, xml er default)

3 Tjeneste 2: hentpersonsted Henter ut personer tilknyttet et sted. Basis URL: /ws/hentpersonsted instnr Heltall Institusjonsnummer brukt i Cristin. (påkrevet) avdnr Heltall Avdelingsnummer (valgfri) undavdnr Heltall Underavdelingsnummer (valgfri) gruppenr Heltall Gruppenummer (valgfri) format Streng Angir hva slags format man ønsker å få levert svaret på. Mulige verdier er xml og json. (valgfri, xml er default) sortering Streng Prioritert sorteringsrekkefølge, spesifisert med en av disse strengene: STED

4 Oversikt over læresteder INSTITUSJONNR INSTITUSJONSNAVN EIERKODE 255Ansgar Teologiske Høgskole ATH 189Arkitektur- og designhøgskolen i Oslo AHO 250Betanien diakonale høgskole BDH 158BI, Handelshøgskolen i Oslo BI 190Det teologiske Menighetsfakultet MF 251Diakonhjemmet Høgskole DHS 253Dronning Mauds Minne Høgskolen DMMH 258Fjellhaug Misjonshøgskole FMH 252Haraldsplass diakonale høgskole HDH 202Høgskolen i Akershus HIAK 203Høgskolen i Bergen HIB 204Høgskolen i Bodø HBO 205Høgskolen i Buskerud HIBU 206Høgskolen i Finnmark HIF 207Høgskolen i Gjøvik HIG 208Høgskolen i Harstad HIH 209Høgskolen i Hedmark HIHM 210Høgskolen i Lillehammer HIL 211Høgskolen i Molde HIM 212Høgskolen i Narvik HIN 213Høgskolen i Nesna HINE 214Høgskolen i Nord-Trøndelag HINT 215Høgskolen i Oslo HIO 216Høgskolen i Sogn og Fjordane HSF 219Høgskolen i Sør-Trøndelag HIST 220Høgskolen i Telemark HIT 222Høgskolen i Vestfold HVE 223Høgskolen i Volda HVO 224Høgskolen i Østfold HIØ 225Høgskolen i Ålesund HIÅ 218Høgskolen Stord/Haugesund HSH 232Høyskolen Diakonova HD Informasjonssenteret for internasjonal 304 utdanning NAIC 230Lovisenberg diakonale høgskole LDH 257Mediehøgskolen Gimlekollen MHG 256Misjonshøgskolen MHS 254NLA Høgskolen NLA 191Norges Handelshøyskole NHH 150Norges idrettshøgskole NIH 194Norges teknisk-naturvitenskapelige universitet NTNU 193Norges veterinærhøgskole NVH 303Opptakssentralen Medisin MED 233Politihøgskolen PHS 302Registreringssentral, Samordna Opptak SOREG 231Sámi allaskuvla / Sámi University College SA/SH 301Samordna opptak SOOP

5 305UNIFOB AS 192Universitetet for miljø- og biovitenskap 201Universitetet i Agder 184Universitetet i Bergen 185Universitetet i Oslo 217Universitetet i Stavanger 186Universitetet i Tromsø UNIFOB UMB UIA UIB UIO UIS UIT

6 Tjeneste 3: hentpersonbilde Henter ut en persons bilde. Personen kan angis enten med navn og eierkode eller med lopenr. Basis URL: /ws/hentpersonbilde eierkode Streng Kode som identifiserer organisasjonen hvor brukernavnet hører hjemme. Må brukes sammen med parameteren navn. navn Streng Brukernavn tiknyttet en organisasjon. Må brukes sammen med parameteren eierkode. lopenr Helltall Unik id for en person i Cristinsystemet. Må ikke brukes sammen med parameterne navn og eierkode.

7 Tjeneste 4: hentvarbeiderperson Henter ut vitenskapelige arbeider tilknyttet en person. Basis URL: /ws/hentvarbeiderperson eierkode Streng Kode som identifiserer organisasjonen hvor brukernavnet hører hjemme. Må brukes sammen med parameteren navn. navn Streng Brukernavn tiknyttet en organisasjon. Må brukes sammen med parameteren eierkode. lopenr Heltall Unik id for en person i Cristinsystemet. Må ikke brukes sammen med parameterne navn og eierkode. format Streng Angir hva slags format man ønsker å få levert svaret på. Mulige verdier er xml og json. (valgfri, xml er default) fra Heltall Årstall. Tar kun med arbeider utgitt fra og med dette året. (valgfri) til Heltall Årstall. Tar kun med arbeider utgitt til og med dette året. (valgfri) utplukk Streng En av alle, nyeste, viktigste (valgfri, alle er default). nyeste og viktigste må brukes sammen med parameteren maksantall. maksantall Heltall Maks antall treff som skal returneres. Må kun brukes sammen med utplukk=viktigst eller utplukk=nyeste. hovedkategori Streng Ta kun med treff fra denne hovedkategorien (valgfri). Se Table 1: Hovedkategorier per 2009

8 underkategori Streng Ta kun med treff fra denne underkategorien (valgfri) Se Table 2: Underkategorier per 2009 sortering Streng Prioritert sorteringsrekkefølge, spesifisert med en av disse strengene: PERSON_TITTEL, AAR_PERSON_TITTEL, HOVEDKAT_PERSON_TITT EL, UNDERKAT_PERSON_TITT EL navn=nilsst&eierkode=uio&fra=2004&til=2010&hovedkategori=bok Table 1: Hovedkategorier per 2009 Hovedkategori FOREDRAG KOMMERSIALISERIN BOK RAPPORT BOKRAPPORTDEL MEDIEBIDRAG PRODUKT UTSTILLING TIDSSKRIFTPUBL OVERSETTELSESARB KUNST_PRODUKSJON INFORMASJONSMATR Table 2: Underkategorier per 2009 Underkategori ANNEN_PRESENTASJ ANNET ANNET_PRODUKT ANTOLOGI ARKITEKTTEGNING ARTIKKEL ARTIKKEL_POP BEDRIFTSETABL BILLEDMATERIALE BOKANMELDELSE BREV_TIL_RED BRIEFS BROSJYRE Forklaring Konferansebidrag og faglig presentasjon Kommersialisering Bok Rapport/avhandling Del av bok/rapport Mediebidrag Produkt Kunstnerisk og museal presentasjon Tidsskriftspublikasjon Oversettelsesarbeide Kunstnerisk produksjon Informasjonsmateriale Forklaring Annet Annet Annet produkt Vitenskapelig antologi Arkitekttegning Vitenskapelig artikkel Populærvitenskapelig artikkel Bedriftsetablering Billedmateriale Anmeldelse Brev til redaktøren Briefs Brosjyre

9 DATABASE DIGITALE_LÆREM DOKUMENTAR DRGRADAVH ERRATA FAGBOK FILMPRODUKSJON FORORD FORSKERLINJEOPPG GJESTEFOREL HOVEDFAGSOPPGAVE INNLEDNING INTERVJU KAPITTEL KOMMENTARUTG KOMPENDIUM KRONIKK KUNST_OG_BILDE LEDER LEKSIKAL_INNF LEKSIKON LESERINNLEGG LISENS LISENSIATAVH LYDMATERIALE LÆREBOK MAGISTERAVH MASTERGRADSOPPG MODELL_ARKITEKT MONOGRAFI MULTIMEDIAPROD MUSEUM MUSIKKARR MUSIKK_DELKOMP MUSIKK_FRAMFORIN MUSIKK_INNSP MUSIKK_KOMP NETTSIDER OPPSLAGSVERK OVERSETTELSE OVERSETTELSE_BOK OVERSETTELSE_KAP OVERSIKTSART PATENT POPVIT_BOK POPVIT_FOREDRAG POSTER PROGDELTAGELSE PROGINNL PROGLEDELSE PROGRAMVARE RAPPORT Database Digitale læremidler Dokumentar Doktorgradsavhandling Errata Fagbok Filmproduksjon Forord Forskerlinjeoppgave Gjesteforelesning Hovedfagsoppgave Innledning Intervju Vitenskapelig Kapittel/Artikkel Vitenskapelig kommentarutgave Kompendium Kronikk Kunst- og billedmateriale Leder Leksikalsk innførsel Leksikon Leserinnlegg Lisens Lisensiatavhandling Lydmateriale Lærebok Magisteravhandling Mastergradsoppgave Modell (arkitektur) Vitenskapelig monografi Multimediaprodukt Museumsutstilling Musikkarrangement Musikk - delkomposisjon Musikalsk framføring Musikk - innspillingsprodukt Musikk - komposisjon Nettsider (opplysningsmateriale) Oppslagsverk Oversettelse Bok Kapittel/Artikkel Vitenskapelig oversiktsartikkel/review Patent Populærvitenskapelig bok Populærvitenskapelig foredrag Poster Programdeltagelse Innledning i musikal og teaterprogram Programledelse Programvare Rapport

10 SAMMENDRAG SEMINAR SHORTCOMM TEATERPRODUKSJON UTST_ARKITEKT UTSTILLINGSKAT UTST_KUNST UTST_WEB VIT_FOREDRAG Sammendrag/abstract Seminar Short communication Teaterproduksjon Arkitektutstilling Utstillingskatalog Kunstutstilling Webutstilling Vitenskapelig foredrag

11 Tjeneste 5: hentvarbeidsted Henter ut vitenskapelige arbeider tilknyttet et sted. Basis URL: /ws/hentvarbeidsted instnr Heltall Institusjonsnummer brukt i Cristin. (påkrevet) avdnr Heltall Avdelingsnummer (valgfri) undavdnr Heltall Underavdelingsnummer (valgfri) gruppenr Heltall Gruppenummer (valgfri) format Streng Angir hva slags format man ønsker å få levert svaret på. Mulige verdier er xml og json. (valgfri, xml er default) fra Heltall Årstall. Tar kun med arbeider utgitt fra og med dette året. (valgfri) til Heltall Årstall. Tar kun med arbeider utgitt til og med dette året. (valgfri) utplukk Streng En av alle, nyeste, viktigste (valgfri, alle er default). nyeste og viktigste kan kun brukes i kombinasjon med parameteren maksantall. maksantall Heltall Maks antall treff som skal returneres. Må kun brukes sammen med utplukk=viktigst eller utplukk=nyeste. hovedkategori Streng Ta kun med treff fra denne hovedkategorien (valgfri). Se Table 1: Hovedkategorier per 2009 underkategori Streng Ta kun med treff fra denne underkategorien (valgfri) Se Table 2: Underkategorier per 2009 sortering Streng Prioritert sorteringsrekkefølge, spesifisert med en av disse

12 strengene: PERSON_TITTEL, AAR_PERSON_TITTEL, HOVEDKAT_PERSON_TITT EL, UNDERKAT_PERSON_TITT EL instnr=185&avdnr=14&underavd=4&gruppenr=0&utplukk=nyeste&maksantall=20 Tjeneste 6: hentpresentasjon Henter ut en presentasjon basert på dens løpenr. Dersom type velges vil ingenting returneres hvis presentasjonen med det gitte løpenummeret er av en annen type enn den som er angitt. Basis URL: /ws/hentpresentasjon lopenr Heltall Tall som identifiserer en presentasjon i Cristin. (påkrevet) type Streng Begrenser treff til presentasjoner av den typen angitt i Table 3: Presentasjonstyper. (valgfri) format Streng Angir hva slags format man ønsker å få levert svaret på. Mulige verdier er xml og json. (valgfri, xml er default) Table 3: Presentasjonstyper Presentasjonstype PROSJEKT GRUPPE ENHET SENTER Forklaring Prosjekt Forskningsgruppe Organisasjonsenhet Forskningssenter

13

14 Tjeneste 7: hentpresentasjonsted Henter ut presentasjoner for et gitt sted, og av en gitt type. Basis URL: /ws/hentpresentasjonsted instnr Heltall Institusjonsnummer brukt i Cristin. (påkrevet) avdnr Heltall Avdelingsnummer (valgfri) undavdnr Heltall Underavdelingsnummer (valgfri) gruppenr Heltall Gruppenummer (valgfri) format Streng Angir hva slags format man ønsker å få levert svaret på. Mulige verdier er xml og json. (valgfri, xml er default) type Streng Begrenser treff til presentasjoner av den typen angitt i Table 3: Presentasjonstyper. (påkrevet)

15 Tjeneste 8: hentpresentasjonbilde Henter ut bilde/logo tilknyttet en presentasjon. Basis URL: /ws/hentpresentasjonbilde lopenr Heltall Tall som identifiserer en presentasjon i Cristin. (påkrevet)