API Dokumentation
UGC-Hubbens API möjliggör att läsa UGC-Hubbens innehåll samt att skriva innehåll om man har tillgång till en API-nyckel. Innehållet är licensierat under CC0.
Läsa innehåll
Paginering, format och sortering
- selectFrom används för att definiera ett offset från det första resultatet.
- maxCount används för att definiera hur många relationer som ska ingå i varje resultat(1-1000).
- format används för att definiera vilket format man vill att APIet ska svara med, standard är XML men denna parameter stödjer även JSON.
- sortOrder används för att definiera hur de returerade relationerna ska sorteras efter när de är skapade. Möjliga värden är desc och asc.
Hämta ett en relation
/UGC-hub/api?method=retrieve&objectUri=all&contentId=2089464&scope=single
Hämta relationer för ett K-Samsök objekt
/UGC-hub/api?method=retrieve&scope=all&objectUri=http://kulturarvsdata.se/raa/fmi/10048200010001
Lista relationer
/UGC-hub/api?method=retrieve&scope=all&selectFrom=10&maxCount=5&objectUri=all
Hämta totala antalet relationer
/UGC-hub/api?method=retrieve&scope=count&objectUri=all
Skapa innehåll
Skapa en relation
/UGC-hub/api?x-api=API-KEY&method=insert&scope=relationAll&objectUri=SOCH-URI&user=USER&relationType=RELATION&relatedTo=TARGET-URI
Radera en relation
/UGC-hub/api?x-api=API-KEY&method=delete&objectId=RELATION-ID