Site icon K-blogg – Riksantikvarieämbetets blogg

Ny API-medtod: Välj vilka element du får i svaret

Vi har fått önskemål om att, i ett API-anrop, kunna definiera vilka element man får tillbaka i svaret. Övriga metoder fungerar som de gjorde före denna uppdatering. Såhär går det till:

recordschema

Recordschema anger vilket record-schema som skall användas för söksvaret, dvs vilket
(XML-)format svarsposterna ska ha. Du kan antingen begära en posts hela
RDF, dess presentationsdata eller valfria fält.
Default är att postens RDF returneras om parametern utelämnas.
Möjliga värden är: rdf, presentation, xml

Exempel: recordSchema=xml

http://www.kulturarvsdata.se/ksamsok/api?x-api=test&method=search&query=geoDataExists=j&recordSchema=xml&fields=itemDescription,itemLabel,lon,lat

PARAMETRAR

fields (obligatorisk om recordSchema=xml, annars oanvänd, se ovan)
Anger vilka fält du önskar i svaret. Nästan alla index man kan söka på
kan anges här i en kommaseparerad lista. Utöver dem även vissa extrafält
som tex thumbnail för att få en posts tumnagel. Fältet itemId läggs
också alltid till i svaret även om den inte finns angiven.
Möjliga värden är: kommaseparerad lista av nästan alla sökbara index
samt thumbnail, url, lon (longitud) och lat (latitud).

Exempel: recordSchema=xml&fields=itemId,itemLabel

http://www.kulturarvsdata.se/ksamsok/api?x-api=test&method=search&query=text=yxa&recordSchema=xml&fields=itemLabel,itemDescription,thumbnail,url

http://www.kulturarvsdata.se/ksamsok/api?x-api=test&method=search&query=geoDataExists=j&recordSchema=xml&fields=itemLabel,itemDescription,lon,lat

>>Johan Carlström – systemförvaltare

Exit mobile version