SummaRise API
SummaRise anvender SOAP som ekstern kommunikationsprotokol. API herfor er beskrevet i de tilhørende WSDL'er, hvor de primære er Search WSDL'en og Storage WSDL'en.
SOAP-kaldene er holdt forholdsvis simple, men i sagens natur er svarene på kaldene mere komplekse.
Afgrænsning
Hvert dokument i Summa har 2 obligatoriske felter: recordID og recordBase.
recordID er en unik ID for dokumentet. Præfix for ID er altid site_ (f.eks. statsbiblioteket_).
recordBase er en sammensætning af site, source og type. site er som ovenfor, source er som udgangspunkt enten ils eller cms. type er den type data som leveres af site_source, som udgangspunkt ddemarc eller xhtml.
Eksempel. Der ønskes en afgrænsning af søgningen "åbningstider" til kun at indbefatte websiderne for Statsbiblioteket: (åbningstider) recordBase:statsbiblioteket_cms_xhtml.
Postopslag
I mange systemer tilbydes fuldpostvisninger, der fremviser ét angivet dokument. I Summa kan posten fra det oprindelige datadump hentes gennem Storage web service. Dette kan gøres med to forskellige kald:
getRecord returnerer posten som defineret i Record.xsd. Med denne indpakning er parent/child relationer til andre poster ekspanderet og eksplicit angivet. getRecord er den anbefalede metode til at hente originaludgaver af posterne.
- getLegacyRecord returnerer på posten på samme vis som den gamle udgave af Summa. Der er ingen schema til formatet. Parent/child relationer håndteres ved at flette MARC-data sammen til et enkelt dokument. getLegacyRecord er forældet og anbefales ikke.
Suggest
Suggest anvendes normalt i form af drop-down-bokse i søgefelter: Brugeren begynder at skrive en søgestreng og der vises en liste over tidligere søgninger, der begynder med denne streng.
TODO