Skip to content

Sök API records

Jump to bottom
nilsw-ra edited this page Jun 21, 2023 · 13 revisions

English version

Sök-API:ets huvudmetod, för sökning och filtrering.

https://data.riksarkivet.se/api/records?...

Parametrar

records-metoden använder query-parametrar för sökvillkor, filtrering, paginering och sortering. Standardvärden på parametrar är markerade med fetstil.

Sökvillkor

Villkorsparametrarna kan kombineras.

Parameter Användning Exempel
text Generell fritextsökning https://data.riksarkivet.se/api/records?text=Nobel
name Fritextsökning på namn https://data.riksarkivet.se/api/records?name=Nobel
place Sökning på refererat platsnamn https://data.riksarkivet.se/api/records?place=Stockholm

Sortering

Parameter Användning Exempel
relevance Relevanssortering (standardvärde) https://data.riksarkivet.se/api/records?text=Nobel&sort=relevance
alphaAsc Alfabetisk A-Ö, i första hand på namn/titel https://data.riksarkivet.se/api/records?text=Nobel&sort=alphaAsc
alphaDesc Alfabetisk Ö-A, i första hand på namn/titel https://data.riksarkivet.se/api/records?text=Nobel&sort=alphaDesc
timeAsc Tidsordning, äldst först https://data.riksarkivet.se/api/records?text=Nobel&sort=timeAsc
timeDesc Tidsordning, nyast först https://data.riksarkivet.se/api/records?text=Nobel&sort=timeDesc

Paginering

Parameter Användning Exempel
offset Startposition i det totala sökresultatet, standardvärde 0 https://data.riksarkivet.se/api/records?text=Nobel&offset=100
max Max antal träffar i svarslistan, standardvärde 100 https://data.riksarkivet.se/api/records?text=Nobel&max=20

Filtrering

Parameter Användning Exempel
year_min Tidigaste årtal https://data.riksarkivet.se/api/records?text=Nobel&year_min=1900
year_max Senaste årtal https://data.riksarkivet.se/api/records?text=Nobel&year_max=1920
facet Facettering av sökresultat, ange ett eller flera filter med facettnamn:värde[;facettnamn:värde]... https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Record;Type:Volume

Tillgängliga facetter för filtrering

Generella

Facettnamn Beskrivning Värden Exempel
ObjectType Objekttyp, informationsslag
  • RecordSet (arkivenhet, samling)
  • Record (arkivenhet, enskild)
  • Agent (auktoritet)
  • Topography (topografi)
 https://data.riksarkivet.se/api/records?text=Vång&facet=ObjectType:Topography
Place Plats, lokalisering Namn på plats, kan vara hierarkiskt uppbyggt t.ex. Sverige/Stockholms län/Stockholms kommun https://data.riksarkivet.se/api/records?text=stockholm&facet=Place:Sverige/Blekinge%20län/Karlshamns%20kommun/Asarums%20församling

Övriga facetter är specifika (eller har specifik värdeuppsättning) per objekttyp.

Arkivenheter, RecordSet

Facettnamn Beskrivning Värden Exempel
Type Arkivenhetstyp
  • Fonds (Arkiv)
  • Series (Serie)
 https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:RecordSet;Type:Series

Arkivenheter, Record

Facettnamn Beskrivning Värden Exempel
Type Arkivenhetstyp
  • Volume (Volym)
  • Dossier (Dossier-akt)
  • Photography (Fotografi)
  • MapDrawing (Karta/ritning)
  • MotionPicture (Rörlig bild)
  • SoundRecording (Ljudupptagning)
  • DigitalImage (ADB-upptagning (bildfil))
  • DigitalFile (ADB-upptagning (fil))
  • DigitalMedium (Databärare för ADB)
  • DigitalImageCopy (Bildfileskopia)
  • Microfilm (Mikrofilm)
  • MicrofilmCopy (Mikrofilmskopia)
  • SearchUtility (Sökhjälpmedel)
  • Component (Komponent)
 https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Record;Type:MapDrawing

Arkivenheter, RecordSet och Record

Facettnamn Beskrivning Värden Exempel
ArchivalInstitution Arkivinstitution (förvarande arkiv) Namn på arkivinstitution, t.ex. Riksarkivet i Stockholm/Täby, Arkivenheten, Region Värmland https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Record;ArchivalInstitution:Riksarkivet%20i%20Täby,%20Krigsarkivet
Provenance Auktoritetskategori för arkivbildare (upphov)
  • GovernmentAuthority (Statlig myndighet)
  • MunicipalAuthority (Kommunal myndighet)
  • Company (Företag)
  • Association (Förening)
  • Village (By)
  • Homestead (Gård)
  • Person (Familj/släkt)
  • Other (Övriga)
  • Unspecified (Ej fastställd)

Auktoriteter

Facettnamn Beskrivning Värden Exempel
Type Auktoritetstyp
  • FormerGovernmentAuthority (Myndighet (upphörd))
  • GovernmentAuthority (Myndighet)
  • ArchivalInstitution (Arkivinstitution)
  • FormerGovernmentAuthorityUnitArkivinstitution (Enhet inom myndighet (upphörd))
  • GovernmentAuthorityUnit (Enhet inom myndighet)
  • Depot (Depå)
  • FormerOrganization (Organisation (upphörd))
  • Organization (Organisation)
  • FormerOrganizationUnit (Organisatorisk enhet (upphörd))
  • OrganizationUnit (Organisatorisk enhet)
    Person (Person)
  • UnidentifiedPerson (Person (oident.))
  • Family (Familj)
  • SystemAuthority (Systemauktoritet)
  • Congress (Kongress)
  • FormerPublicContractor (Organ med offentligt uppdrag (upphört))
  • PublicContractor (Organ med offentligt uppdrag)
 https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Agent;Type:Family

Topografier

Facettnamn Beskrivning Värden Exempel
Type Topografityp
  • Country (Land)
  • County (Län)
  • Bailiwick (Fögderi / stad)
  • Parish (Socken / församling)
  • Municipality (Kommun)
  • Diocese (Stift)
  • Decanate (Kontrakt)
  • Pastorship (Pastorat)
  • CourtOfAppeal (Hovrätt)
  • Jurisdiction (Domsaga / rådhusrätt)
  • Hundred (Härad / stad / skeppslag)
  • DistrictCourt (Tingsrätt)
  • MilitaryDivision (Militär indelning)
  • Province (Landskap)
  • AncientProvince (Folkland)
  • SettlementUnit (Bebyggelseenhet)
    ParishPart (Sockendel / skate)
 https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Topography;Type:Parish

Sökresultat

Sökresultatet är ett JSON-objekt med fyra beståndsdelar.

Header

Header-sektionen består av fyra element direkt i toppen av resultatobjektet:

Element Beskrivning
totalHits Totalt antal träffar i sökningen
hits Antal träffar på den här pagineringssidan av sökningen
offset Position i pagineringen av sökningen, som antal resultatposter, inte sidnummer, så innebär t.ex. hits=100, offset=200 att sökresultatet listar post 201-300 i det totala resultatet 
{
   "totalHits": 1912668,
   "hits": 100,
   "offset": 0,
   ...

Facetter

Facetter för filtrering av sökresultatet finns i en array under elementet facets.

   ...
   "facets": [
      ...
   ],
   ...

Varje facett är ett objekt med följande element:

Element Beskrivning
name Facettnamn:
  • ObjectType
  • Type
  • ArchivalInstitution
  • Provenance
  • Place
values En array med facettvärden

Facettvärde

JSON-objekt med följande element:

Element Beskrivning
value Värde (text)
hits Antal träffar som har det värdet i facettfältet (heltal)
url URL till sök-API för att göra samma sökning, med filtrering på aktuellt facettvärde
T.ex. https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType%3ARecord%3BType%3AVolume&offset=0&max=100&sort=relevance
OBS! URL-encoding
subFacets (finns inte alltid) Lista med underfacetter, dvs filtrering specifik för det överordnade facettvärdet, underfacetter har samma struktur som facettvärden, se nedan 
   "facets": [
      ...,
      {
         "name": "Provenance",
         "values": [
            {
               "value": "GovernmentAuthority",
               "hits": 1474491,
               "url": "https://data.riksarkivet.se/api/records?text=stockholm&facet=Provenance%3AGovernmentAuthority&offset=0&max=100&sort=relevance"
            },
            {
               "value": "Other",
               "hits": 127972,
               "url": "https://data.riksarkivet.se/api/records?text=stockholm&facet=Provenance%3AOther&offset=0&max=100&sort=relevance"
            },
            ...
         ]
       },
       ...
   ]

Resultatlista

Själva resultatlistan finns som en array under elementet items.

Resultatpost

JSON-objekt med följande element:

Element Beskrivning
id Postens persistenta id (text), ser lite olika ut för olika objekttyper

  • Arkivenheter - Base 62-enkodad UUID, t.ex. 63zworBzgX0hO3dzp9XkbC
  • Auktoriteter - Base 62-enkodad UUID, t.ex. iptBxAgXqn6ULG2G9x3yT1
  • Topografier - databas-id, numeriskt, upp till 9 siffror, t.ex. 569
objectType Objekttyp

  • RecordSet - arkivenhet, samling
  • Record - arkivenhet, enskild
  • Agent - auktoritet
  • Topography - plats
type Detaljerad typ, inom respektive objekttyp (text)
caption Namn/titel (text)
metadata JSON-objekt med metadata om posten, exakt uppsättning element skiljer mellan objekttyperna
_links JSON-objekt med länkar till olika representationer av posten

  • self - postens länkade data-URI
  • html - webbsida för posten
  • rdf/xml - RDF, serialiserad som RDF/XML
  • json-ld - RDF, serialiserad som JSON-LD
  • ead/ra - EAD-XML, Riksarkivets EAD 2002-schema (endast arkivenheter)
  • ead/ape - EAD-XML, Archives Portal Europes schema (endast arkivenheter)
  • image - URI till IIIF-manifest (om det finns tillgängligt)

Metadata

Arkivenheter

Element Beskrivning
referenceCode Referenskod, människoläsbar arkividentitet (text)
hierarchy Arkivenhetens hierarki, arkiv/underarkiv/serie/underserie/..., array med JSON-objekt

  • uri - arkivenhetens länkade data-URI
  • caption - arkivenhetens namn/titel
  • date - datering
provenance Arkivbildare, ursprung, array med JSON-objekt, samma struktur som hierarchy
archivalInstitution Arkivinstiution, förvarande arkiv, array med JSON-objekt, samma struktur som hierarchy
date Datering (text), OBS! dateringen är inte normaliserad utan kan innehålla mer text än bara årtal, t.ex. "1951 - November 1. Stockholm - Södermanland 1."
note Anmärkning (text) 
   ...
   "metadata": {
      "referenceCode": "SE/RA/1209/01/1/30/5578",
      "hierarchy": [
         {
            "caption": "Finansdepartementet/Budgetdepartementet",
            "uri": "http://data.riksarkivet.se/archive/dYINeBUQrH6d0002H087k3"
         },
         {
            "caption": "Finansdepartementet. Huvudarkivet",
            "uri": "http://data.riksarkivet.se/archive/doINeBUQrH6d0002H087k3"
         },
         {
            "caption": "Huvudarkiv",
            "uri": "http://data.riksarkivet.se/archive/2SRdhLyUkI1PY4mZNXY1D0"
         },
         {
            "caption": "EIa Konseljakter",
            "uri": "http://data.riksarkivet.se/archive/1ziJGUpj9YBLoOBQauZhP7"
         }
      ],
      "provenance": [
         {
            "caption": "Finansdepartementet",
            "uri": "http://data.riksarkivet.se/agent/VlaTA8hDrH646m3GjpvwY3"
            "date": "1840 - "
         }
      ],
      "archivalInstitution": [
         {
            "caption": "Riksarkivet i Stockholm/Täby",
            "uri": "http://data.riksarkivet.se/agent/nyzaW7QeDCHdbK0a2Umzd9"
         }
      ],
      "date": "1951 - November 1. Stockholm - Södermanland 1."
   },
   ...

Auktoriteter

Element Beskrivning
referenceCode Referenskod, människoläsbar identitet (text)
date Datering (text), OBS! dateringen är inte normaliserad utan kan innehålla mer text än bara årtal

Topografier

Element Beskrivning
referenceCode Referenskod, människoläsbar identitet (text)
partOf Närmast överordnade topografier, array med JSON-objekt, samma struktur som hierarchy för arkivenheter
date Datering (text), OBS! dateringen är inte normaliserad utan kan innehålla mer text än bara årtal

Länkar

Länkar för sökresultatet som helhet finns i ett JSON-objekt under elementet _links.

Element Beskrivning
self URL till den aktuella sökningen
next URL till nästa sida i pagineringen (ny offset = offset + max)
previous URL till föregående sida i pagineringen (ny offset = offset - max) 
   _links": {
      "self": "https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Topography&offset=100&max=100",
      "next": "https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Topography&offset=200&max=100",
      "previous": "https://data.riksarkivet.se/api/records?text=stockholm&facet=ObjectType:Topography&offset=0&max=100"
   }

Riksarkivet

Clone this wiki locally