Introduction
...
All of the published records can have relationships to each other, regardless of the presentations they appear in. Records can have multiple children and/or multiple parents.
- (Member – A member is an entity that represents a record in a presentation. The member holds the record, in addition to presentation-specific attributes like position and map coordinates)
- Record – The main object (a kulturpunkt is a record). A record can have a image, title and description in multiple languages (under 'content'). A record can be a building, a painting, a person, or similar. The rest of the content is located in the record's pages.
- Language - An abstract level. Each page belongs to one (and only one) language.
- Page – Pages belong to a record. A record can have multiple pages. Pages are the main container for contents, organized in content blocks. Having more than one page in each record is not recommended.
- Block - Blocks of content. See "Types" for the different types of blocks. The type "image_video" can contain a mix of images and videos.
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"data": [
{
"distance": 52567,
"id": 3292,
"location": {
"latitude": 61.1145543,
"longitude": 10.4615076
},
"owner_id": 54
},
{
"distance": 12164243,
"id": 5187,
"location": {
"latitude": -55.98333299999999,
"longitude": -67.2666668
},
"owner_id": 51
}
],
"result": "success"
} |
Get owners nearby
/v2/ |
|---|
GET
Returns list of simple version of one recordParameters: None
owner/nearby?location=61.108960,10.466015&start=0&rows=5
|
|---|
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ result: "success", "data": [ { { "contentsid": {289, "dename": { "Norsk Folkemuseum", "activedescription": false,"<p>Norsk Folkemuseum is located at Bygdøy, Oslo.</p>", "descriptiondistance": null,70664, "location": { "pageslatitude": []61.114347, "titlelongitude": null10.463788 }, "engroups": {[ { "active": false, "descriptiondefault_language": null"en", "pagesid": []877, "titleplatform": null"mobile", }, "status": "published", "es": { "activetitle": false, "The open air museum" "description": null}, { "pages": [], "titledefault_language": null"en", }, "id": 875, "fr": { "activeplatform": false"mobile", "description "status": null"published", "pagestitle": [], "Paintings from the 17. century" "title": null} },] } ] } |
Get all owners
/v2/owners/GETReturns all owners Parameters: None
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
Get owners nearby
/v2/owner/nearby
GET
Returns owner nearby a specified location
Example: https://api.kulturpunkt.org/v2/owner/nearby?location=61.108960,10.466015&start=0&rows=5
| Parameter | Type | Description | Required |
|---|---|---|---|
| location | String | latitude and longitude, separated by comma | Yes |
| start | Integer | Offset in result set. Use for paging | No (default is 0) |
| rows | Integer | Nr of results. Use for paging. Maximum 20 | No (default is 5) |
...
| language | js |
|---|---|
| theme | Confluence |
| title | Example of return data |
| linenumbers | true |
| collapse | true |
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
...
|
|---|
Get
...
one owner, with groups
/v2/owners/<owner_id>GETReturns all owners Parameters: None Code Block | language | js | title | Example of one owner, with groups
|
|---|
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
|
...
" |
...
data" |
...
: |
...
{ |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
"default_language": "sv", "description": "<p>Nordiska Museet sine utstillinger.</p>", |
...
"location": {
|
...
"latitude": 61.114347, |
...
|
...
"longitude": 10.463788 }, |
...
"groups": [ |
...
{ |
...
|
...
"contents": {
|
...
" |
...
sv": { |
...
"description": |
...
"Beskrivning", |
...
"title": " |
...
Tittel" |
...
|
...
} |
...
|
...
},
|
...
"default_language": " |
...
sv", |
...
"id": |
...
187, |
...
"start_record_id": |
...
2201, |
...
"title": " |
...
Testtittel" |
...
|
...
} |
...
|
...
] |
...
,
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
" |
...
id": |
...
48, |
...
"identifier": " |
...
s-nm", |
...
"name": |
...
"Nordiska museet" |
...
}, " |
...
result": "success"
} |
Get one group, with presentations
/v2/owners/<owner_id>/groups/<group_id>GET Returns one group, with presentations and their metadata
|
|---|
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ result: "success", "data": { "contents": { " |
...
sv": { |
...
"description": "Nybble-beskrivning", "title": " |
...
Nybble" |
...
},
|
...
|
...
"en": {
|
...
"description": "Nybble-description", |
...
"title": |
...
"Nybble ..." }, "no": { " |
...
description": "Nybble-beskrivelse" |
...
, |
...
"title": "Nybble ..." } }, "languages": [ |
...
{ " |
...
code": " |
...
en", |
...
|
...
" |
...
name": |
...
{ " |
...
name": |
...
"English", " |
...
native_name": " |
...
English" } |
...
Get one owner, with groups
/v2/owners/<owner_id>
GET
Returns one owner, with groups
| Parameter | Type | Description | Required |
|---|---|---|---|
| owner_id | Integer | Owner's id | Yes |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ }, { "data": { "default_language"code": "sv", "description": "<p>Nordiska Museet sine utstillinger.</p>", "location "name": { "latitude": 61.114347, "name": "Swedish", "longitude": 10.463788 }, "groupsnative_name": ["Svenska" { } "contents": {}, { "sv": { "code": "no", "descriptionname": "Beskrivning", { "titlename": "TittelNorwegian", } "native_name": "Norsk" }, } ], "default_language": "sv", "id": 187, "idpresentations": 187, [ { "start_record_idcontents": 2201, { "titlesv": "Testtittel" { } ],"description": "Nybble-beskrivning-karta", "id": 48, "identifiertitle": "s-nm",Karta" } "name": "Nordiska museet" }, "result "icon": "success" } |
Get one group, with presentations
/v2/owners/<owner_id>/groups/<group_id>
GET
Returns one group, with presentations and their metadata
| Parameter | Type | Description | Required |
|---|---|---|---|
| owner_id | Integer | Owner's id | Yes |
| group_id | Integer | Group's id | Yes |
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ result: "success", "data": {http://mm01.dimu.no/image/012uPWhYiDXd", "contentsid": {507, "sv": { "type": "map_google" "description": "Nybble-beskrivning",} ], "titlestart_record_id": "Nybble"2201, }, "en": {"start_record_image": "http://mm01.dimu.no/image/012uPWhYiDXd", "title": "Nybble" } } |
Get one presentation, with records
/v2/owners/<owner_id>/presentations/<presentation_id>GET Returns one presentation, with records and their metadata
|
|---|
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "data": { "description": "Nybble-description", "contents": { "titlesv": { "Nybble ..." }, "nodescription": {"Nybble-beskrivning-karta", "descriptiontitle": "Nybble-beskrivelse",Karta" } }, "titlegroup": "Nybble ...", "group_id": 187, } }, "languages": ["id": 507, "map_type": "HYBRID", { "records": [ "code": "en", { "namecontents": { "namesv": "English", { "native_namedescription": "English", } "title": "Tre generationer vägar" }, { } "code": "sv" }, "namelocation": { "namelatitude": "Swedish"59.158996, "native_namelongitude": "Svenska"16.020583 }, }, "member_id": 5283, { "position": 1, "coderecord_id": "no"1737, "nameresources": [ { "nameid": "Norwegian"4620, "native_name "type": "Norskimage", } "url": "http://mm01.dimu.no/image/012uPWhYiDTA" } ],} "default_language": "sv", ] "id": 187, "presentations": [ }, { "contents": { "sv": { "description": "Nybble-beskrivning-karta", "title": "KartaPotatisåkern" } }, "iconlocation": "http://mm01.dimu.no/image/012uPWhYiDXd",{ "idlatitude": 50759.159751, "typelongitude": "map_google" 16.019469 }, ], "member_id": 5284, "start_record_id "position": 22012, "start_ "record_imageid": "http://mm01.dimu.no/image/012uPWhYiDXd"1802, "title": "Nybble" "resources": [ { "id": 8221, } } |
Get one presentation, with records
/v2/owners/<owner_id>/presentations/<presentation_id>
GET
Returns one presentation, with records and their metadata
| Parameter | Type | Description | Required |
|---|---|---|---|
| owner_id | Integer | Owner's id | Yes |
| presentation_id | Integer | Presentation's id | Yes |
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "data": { "type": "contents": {image", "sv": { "url": "http://mm01.dimu.no/image/012wWWjuUGRs" "description": "Nybble-beskrivning-karta", } "title": "Karta" ] } }, "group": "Nybble", { "group_id": 187, "id": 507, "map_type": "HYBRID", "records": [ { "contents": { "sv": { "description": "", "title": "TrePotatisgropar generationersom vägarförvaring" } }, "location": { "latitude": 59.158996159092, "longitude": 16.02058301921 }, "member_id": 52835285, "position": 13, "record_id": 17371800, "resources": [ { "id": 46204621, "type": "image", "url": "http://mm01.dimu.no/image/012uPWhYiDTA012uPWhYiDTB" } ] }, { "contents": { "sv": { "description": "Nybble är namnet på denna historiska plats som är en del av Julita gård.", "title": "PotatisåkernVälkommen till Nybble" } }, "location": { "latitude": 59.159751158822, "longitude": 16.019469020963 }, "member_id": 52845287, "position": 24, "record_id": 18022201, "resources": [ { "id": 82214633, "type": "image", "url": "http://mm01.dimu.no/image/012wWWjuUGRs012uPWhYiDXd" } ] }, { "contents": { "sv": { "description": "", "title": "PotatisgroparMitt i somNybble förvaringby" } }, "location": { "latitude": 59.159092159556, "longitude": 16.01921020676 }, "member_id": 52855288, "position": 35, "record_id": 18001801, "resources": [ { "id": 46214628, "type": "image", "url": "http://mm01.dimu.no/image/012uPWhYiDTB012uPWhYiDXY" } ] }, { "contents": { "sv": { "description": "Nybble är namnet på denna historiska plats som är en del av Julita gård.", "title": "VälkommenFattigstugan tillfrån Nybble1742" } }, "location": { "latitude": 59.158822159422, "longitude": 16.020963018447 }, "member_id": 52875289, "position": 46, "record_id": 22011799, "resources": [ { "id": 46334623, "type": "image", "url": "http://mm01.dimu.no/image/012uPWhYiDXd012uPWhYiDTD" } ] }, ], { "contents"resources": { "svicon": { null, "description"map_image": ""null, }, "titletype": "Mitt i Nybble by" map_google" }}, }, "location": { "latitude": 59.159556, "longitude": 16.020676 }, "result": "success" } |
Get one record
/v2/owners/<owner_id>/groups/<group_id>/records/<record_id>GET Returns a published record, with its content, pages, location and license, along with related records and the presentation(s) it belongs to.
Example: /v2/owners/1/groups/4/records/2?presentation_id=3 |
|---|
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "data": { "memberall_idpresentations": 5288,[ { "position": 5, "contents": { "record_id": 1801, "resourcesde": [{ { "title": "" "id": 4628}, "typeen": "image",{ "urltitle": "http://mm01.dimu.no/image/012uPWhYiDXY" }, ] "es": { }, "title": "" { "contents": { }, "svfr": { "descriptiontitle": "", }, "title": "Fattigstugan från 1742" "no": { } "title": "" }, "location": { }, "latitudesv": 59.159422, { "longitudetitle": 16.018447"Karta" }, "member_id": 5289}, "positionid": 6507, "record_idtype": 1799,"map_google" } "resources": [ ], "children": [ { { "idcontents": 4623,{ "typesv": "image",{ "urldescription": "http://mm01.dimu.no/image/012uPWhYiDTD"", } "title": "Mitt i Nybble by" ] } ], "resources": { }, "icon": null, "map_image": null, }, "type": "map_google"{ }, "result": "success" } |
Get one record
/v2/owners/<owner_id>/groups/<group_id>/records/<record_id>
GET
Returns a published record, with its content, pages, location and license, along with related records and the presentation(s) it belongs to.
| Parameter | Type | Description | Required |
|---|---|---|---|
| owner_id | Integer | Owner's id | Yes |
| record_id | Integer | Record's id | Yes |
| presentation_id | Integer | Used to specify which presentation the record belongs to (or which presentation the user came from). | No |
Example: /v2/owners/1/groups/4/records/2?presentation_id=3
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "dataurl": "http: {//mm01.dimu.no/image/012uPWhYiDXX" }, "allrecord_presentationsid": [1801 }, { "contents": { "desv": { "description": "", "title": "Potatisåkern" } }, "image": { "url": "http://mm01.dimu.no/image/012wWWjuUGRs" "en": { }, "titlerecord_id": 1802 "" }, }, { "escontents": { "titlesv": ""{ }, "description": "", "fr": { "title": "Fattigstugan från 1742" "title": "" } }, "noimage": { "titleurl": "http://mm01.dimu.no/image/012uPWhaCXzE" }, }, "record_id": 1799 "sv": { }, { "title": "Karta" "contents": { } "sv": { }, "iddescription": 507"", "type": "map_google" "title": "Potatisgropar som förvaring" } ], } "children": [ {}, "contentsimage": { "url"sv: "http: {//mm01.dimu.no/image/012uPWhYiDTB" }, "description "record_id": "", 1800 } ], "titlecontents": "Mitt{ i Nybble by" "sv": { } "description": "", }, "pages": [ "image": { { "url": "http://mm01.dimu.no/image/012uPWhYiDXX" "blocks": [ }, "record_id": 1801 { }, { "contentsdata": {[ "sv": { { "description": "", "title": "Potatisåkern" "contents": { } }, "imagesv": { "url": "http://mm01.dimu.no/image/012wWWjuUGRs" }, "description": "", "record_id": 1802 }, { "contentstitle": {"Kartan visar var de tidigare landsvägarna låg" "sv": { "description": "", } "title": "Fattigstugan från 1742" }, } }, "imagecredits": {[ "url": "http://mm01.dimu.no/image/012uPWhaCXzE" }, { "record_id": 1799 }, { "name": "Lantmäteriet, bearbetning Anna "contents": {Berg", "sv": { "descriptiontype": "", "photographer" "title": "Potatisgropar som förvaring" } }, "image": { ], "url": "http://mm01.dimu.no/image/012uPWhYiDTB" }, "dms_id": "012wWWQMLQxp", "record_id": 1800 } ], "contentsfilename": { "Nybblekarta5.jpg", "sv": { "description": "", "id": 6944, "pages": [ { "type": "image", "blocks": [ "url": "http://mm01.dimu.no/image/012wWWQMLQxp" { "data": [ }, { "contents": { "sv": { "description": "", "title": "KartanDen äldsta visarvägdragningen varpå dekarta tidigarefrån landsvägarnaår låg1775." } }, "credits": [ { "name": "Lantmäteriet,Ur bearbetningNordiska Annamuseets Bergarkiv", "type": "photographer" } ], "dms_id": "012wWWQMLQxp012wWWQMLR35", "filename": "Nybblekarta5Nybbleutsnitt.jpg", "id": 69446945, "type": "image", "url": "http://mm01.dimu.no/image/012wWWQMLQxp012wWWQMLR35" }, { "contents": { "sv": { "description": "", "title": "DenLindar äldstaär vägdragningenen pådel kartaav frånden årgamla 1775allén." } }, "credits": [ { "name": "Ur Nordiska museets arkiv", "credits": [ "type": "photographer" { } "name": "Karolina Kristensson, Nordiska museet", ], "dms_idtype": "012wWWQMLR35photographer", "filename": "Nybbleutsnitt.jpg", } "id": 6945], "typedms_id": "image012uPWhYiDTA", "urlfilename": "http://mm01.dimu.no/image/012wWWQMLR35"_FOA5556.jpg", }, "id": 4620, { "type": "image", "contents": { "url": "http://mm01.dimu.no/image/012uPWhYiDTA" "sv": { } ], "description": "", "id": 5034, "title": "Lindar är en del av den gamla allén."position": 1, "type": "image_video" } }, }, { "creditsdata": [ { { "contents": { "name": "Karolina Kristensson, Nordiska museet", "sv": { "type": "photographer" "description": "Tre generationer vägar", } "title": "Tre generationer vägar" ], "dms_id": "012uPWhYiDTA",} "filename": "_FOA5556.jpg"}, "idcredits": 4620[], "typedms_id": "image012wWWQGs6or", "urlfilename": "http://mm01.dimu.no/image/012uPWhYiDTA"Tre generationer vägar.mp3", } "id": 5796, ], "idtype": 5034"audio", "position": 1, "url": { "type": "image_video" "mp3": "http://mm.dimu.org/multimedia/012wWWQGs6or.mp3?mmid=012wWWQGs6or&a=none", }, { "ogg": "http://mm.dimu.org/multimedia/012wWWQGs6or.ogg?mmid=012wWWQGs6or&a=none" "data": [ } { } "contents": { ], "id": 6755, "sv": { "position": 2, "description": "Tre generationer vägar", "type": "audio" }, "title": "Tre generationer vägar" { } "data": "<p>Landsvägen har genom åren haft tre olika sträckningar genom Nybble.</p>", }, "id": 5035, "creditsposition": [], 3, "dms_id"type": "012wWWQGs6ortext", "filename": "Tre generationer vägar.mp3", }, { "id": 5796, "typecontents": { "audio", "url": { "mp3no": "http://mm.dimu.org/multimedia/012wWWQGs6or.mp3?mmid=012wWWQGs6or&a=none", { "oggdescription": "http://mm.dimu.org/multimedia/012wWWQGs6or.ogg?mmid=012wWWQGs6or&a=none"", } "title": "Test av Sketchfab-objekt" } } ], }, "id": 6755, "positioncredits": 2[], "type": "audio" "id": 16229, }, "owner_id": 37, { "datatitle": "Sketchfab-test"<p>Landsvägen, har genom åren haft tre olika sträckningar genom Nybble.</p>", "idtype": 5035,"sketchfab", "positiontype_id": 38, "type "u_id": "text"block-20653-resource-20653", }, { "url": "https://sketchfab.com/models/a668103a96874b80a8421f22fbb5c74f/embed", } ], "contents": { "id": 3097, "position": 1, "title": "Tre generationer vägar" } "no": { ], "title": "Tre generationer vägar" } "description": "", }, "id": 1737, "images": [], "license": { "titlecode": "Test av Sketchfab-objekt"copyright", "description": "Copyright", "id": 1 }, } "location": { "latitude": 59.158996, "longitude": 16.020583 }, "parents": [ { "creditscontents": [], { "sv": { "iddescription": 16229,"Nybble är namnet på denna historiska plats som är en del av Julita gård.", "owner_idtitle": 37, "Välkommen till Nybble" } "title": "Sketchfab-test"}, "image": { "typeurl": "sketchfab",http://mm01.dimu.no/image/012uPWhYiDXd" }, "typerecord_id": 8,2201 }, { "u_idcontents": "block-20653-resource-20653", { "sv": { "urldescription": "https://sketchfab.com/models/a668103a96874b80a8421f22fbb5c74f/embed", "title": "Mitt i Nybble by" } } ], }, "idimage": 3097, { "positionurl": 1,"http://mm01.dimu.no/image/012uPWhYiDXX" }, "title": "Tre generationer vägar" "record_id": 1801 } }, ],{ "titlecontents": "Tre generationer vägar" { } "sv": { }, "id": 1737, "imagesdescription": []"", "license": { "codetitle": "copyrightPotatisåkern", "description": "Copyright", } "id": 1 }, "locationimage": { "latitudeurl": 59.158996,"http://mm01.dimu.no/image/012wWWjuUGRs" "longitude": 16.020583 }, }, "parentsrecord_id": [1802 {}, { "contents": { "contents": { "sv": { "sv": { "description": "Nybble är namnet på denna historiska plats som är en del av Julita gård."description": "", "title": "VälkommenFattigstugan tillfrån Nybble1742" } }, "image": { "url": "http://mm01.dimu.no/image/012uPWhYiDXd012uPWhaCXzE" }, "record_id": 22011799 }, { "contents": { "sv": { "description": "", "title": "MittPotatisgropar isom Nybble byförvaring" } }, "image": { "url": "http://mm01.dimu.no/image/012uPWhYiDXX012uPWhYiDTB" }, "record_id": 18011800 } ], "presentation": { "contents": { "contentssv": { "title": "Karta" } }, "id": 507, "sv "type": {"map_google" }, "use_simple_list": true }, "result": "descriptionsuccess": "", } |
Comments: All_presentations contains all of the presentations the record is a member of.
Presentation contains the presentation specified in parameter presentation_id.
Children contains related records, usually meaning something like "These are naturally the next records to check out!"
Parents also contains related records, but these are records that naturally leads to this one (previous).
Get simple record
/v2/owners/<owner_id>/records/<record_id>/simpleGET Returns a simple version of one record Example: https://api.kulturpunkt.org/v2/owners/51/records/5085/simple Parameters: None |
|---|
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "data": { "titlecontents": "Potatisåkern"{ "de": { } }"active": false, "imagedescription": {null, "urlpages": "http://mm01.dimu.no/image/012wWWjuUGRs" }[], "record_idtitle": 1802null }, "en": { "contentsactive": { false, "svdescription": { null, "descriptionpages": ""[], "title": "Fattigstugannull från 1742" }}, },"es": { "imageactive": {false, "urldescription": "http://mm01.dimu.no/image/012uPWhaCXzE"null, }"pages": [], "record_idtitle": 1799null }, "fr": { "contentsactive": {false, "svdescription": {null, "description"pages": ""[], "title": null "title": "Potatisgropar som förvaring" }, "no": { } }"active": false, "imagedescription": { null, "urlpages": "http://mm01.dimu.no/image/012uPWhYiDTB" [], },"title": null }, "record_id": 1800 "sv": { } ], "active": true, "presentation": { "contentsdescription": {null, "svpages": {[], "title": "Karta"Briggen ANNA CHATARINA" } } }, }, "group_id": 380, "id": 5075085, "typeimage": "map_google" }https://dms-cf-09.dimu.org/image/032ykz1yJe1V", "useowner_simple_listid": true51 }, "result": "success" } |
...
Get geographically placed records from a group
...