Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
<Kontaktuppgifter till utvecklare/teknisk förvaltare>

Beskrivning

<Beskriv vad din applikation/mikrotjänst gör>

Livscykelstatus

<någon av: design, under utveckling, test, produktion, under avveckling, avvecklad>

Lösningsbeskrivning

<Infoga en Gliffy-bild som visuellt beskriver lösningen>

Hantering av personuppgifter

<Vilka personuppgifter hanteras och varför?>

API specifikation

<API specifikation>

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

Tillgängliggöra information om friluftsanläggningar i Sundsvalls kommun

Livscykelstatus

produktion

Lösningsbeskrivning

Samtliga anrop levererar GeoJSON-Features, om fler än en Feature returneras så grupperas dessa i en FeatureCollection. Se GeoJSON-specifikationen på https://geojson.org/
Objekt som är opublicerade, dvs har flaggan published: false, har ”geometry”: null och saknar egenskapen ”fields”

Hantering av personuppgifter

Bilder med personer förekommer. Då ska dessa finnas godkända i Kultur och fritids system för att hantera bilder.

API specifikation

Samtliga anrop levererar GeoJSON-Features, om fler än en Feature returneras så grupperas dessa i en FeatureCollection. Se GeoJSON-specifikationen på https://geojson.org/
Objekt som är opublicerade, dvs har flaggan published: false, har ”geometry”: null och saknar egenskapen ”fields”

Exempel på svar

Multi polygon

Exempel på ett Feature-objekt med geometri av typen MultiPolygon (yta):
{
"id": 1600,
"type": "Feature",
"properties": {
"name": "Strandbad Västerlövsjön",
"type": "Strandbad",
"created": "2020-07-07 14:22:32",
"published": true,
"fields": [{
"name": "Typ av bänkbord",
"type": "DROPDOWN",
"value": "2 tums standard"
}]
},
"geometry":{
"type":"MultiPolygon", "coordinates":[
[
[
[619548.055704311,6917131.368104064], [619531.7116535523,6917104.258981411],[619534.0864301582,6917073.063846069],[619510.3386640984,6917045.326106079],[619540.65198901,6917024.503156795],[619502.8790717006,6917016.117517933],[619497.1516692981,6916992.701522135], [619548.055704311,6917131.368104064]
]
]
]
}
}

LineString

Exempel på ett Feature-objekt med geometri av typen LineString (linje):
{
"id": 1542,
"type": "Feature",
"properties": {
"name": "Elit 6 km",
"type": "Motionsspår",
"created": "2020-05-12 15:30:05",
"updated": "2020-11-09 09:15:57",
"published": true,
"owner": {
"organizationID": 36,
"name": "Sundsvalls kommun Friluftsenheten"
},
"manager": {
"organizationID": 36,
"name": "Sundsvalls kommun Friluftsenheten"
},
"fields": [{
"name": "Statusdatum",
"type": "DATE",
"value": "2020-05-12"
}, {
"name": "Svårighet",
"type": "DROPDOWN",
"value": "Svår"
}, {
"name": "Tillgänglighetsanpassad",
"type": "TOGGLE",
"value": "Nej"
}, {
"name": "Beskrivning",
"type": "FREETEXT",
"value": "Motionsspår vid Friluftscentrum Södra Berget med tuffa backar både utför och uppför. Riktigt vacker skidåkning på Stora Bergssvängen där Jaktkojan passeras efter knappt fyra kilometer."
}, {
"name": "Felanmälan länk",
"type": "FREETEXT",
"value": "https://sundsvall.se/kommun-och-politik/overklaga-beslut-rattssakerhet/dialog-och-synpunkter/felanmal/"
}, {
"name": "Felanmälan e-post",
"type": "FREETEXT",
"value": "fritidsinformation@sundsvall.se"
}, {
"name": "Längd (meter)",
"type": "INTEGER",
"value": 4600
}, {
"name": "Tillhörande filer",
"type": "FILES",
"value": [{
"id": 1458,
"filename": "Elit 6.pdf",
"type": "application/pdf",
"size": 456673,
"url": "https://anlaggning.sundsvall.se/filesfield/api/1458"
}, {
"id": 1853,
"filename": "20200703_081547.jpg",
"type": "image/jpeg",
"size": 7406534,
"url": "https://anlaggning.sundsvall.se/filesfield/api/1853"
}]
}]
},
"geometry": {
"type": "LineString",
"coordinates": [
[619453.6484280995, 6917136.515187976],
[619453.2414101328, 6917149.034866458],
[619450.6102589302, 6917154.320959071],
[619444.4996618445, 6917160.111501124],
[619435.7864560867, 6917163.329091088],
[619394.2254019114, 6917155.769792947],
[619356.7803122852, 6917148.495942925],
[619283.0525943588, 6917107.212973353],
[619267.702848834, 6917097.459136161]
]
}
}

Point

Exempel på ett Feature-objekt med geometri av typen Point (punkt):
{
"id": 1600,
"type": "Feature",
"properties": {
"name": "Bänkbord Västerlövsjön",
"type": "Bänkbord",
"created": "2020-07-07 14:22:32",
"published": true,
"owner": {
"organizationID": 36,
"name": "Sundsvalls kommun Friluftsenheten"
},
"manager": {
"organizationID": 36,
"name": "Sundsvalls kommun Friluftsenheten"
},
"fields": [{
"name": "Typ av bänkbord",
"type": "DROPDOWN",
"value": "2 tums standard"
}]
},
"geometry": {
"type": "Point",
"coordinates": [601454.364, 6928117.727999999]
}
}

Fälttyper

Under egenskapen ”fields” i svaret så represnteras varje fälttyp kopplad till objektet. Varje fälttyp har sin egen struktur i API:et. Nedan följer exempel på aktuella fälttypers strukturer. Alla attribut är inte garanterade.

Byggnad

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”BUILDING”,
”buildingName”: ”Byggnadens namn”,
”buildingStatus”: ”Byggnadens status”,
”buildingGuid”: ”Byggnadens GUID”
}

Datum

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”DATE”,
”value”: ”Valt datum”
}

Rullista

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”DROPDOWN”,
”value”: ”Valt värde”
}

Filer

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”FILES”,
”value”: [
{
”id”: ”Filens ID”,
”filename”: ”Filens namn”,
”description”: ”Beskrivning av filen”,
”alttext”: ”Alternativ text (för bilder)”,
”sourcetext”: ”Källtext för filen”,
”validForWinter”: ”Om filen är giltig för vinter”,
”validForSummer”: ”Om filen är giltig för sommar”,
”sortIndex”: ”Sorteringsindex för fil bland filer”,
”type”: ”Filtyp (mime)”,
”size”: ”Filens storlek”, ”url”: ”Adress till filen”
}
]
}

Fritext

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”FREETEXT”,
”value”: ”Valt värde”
}

Nummer

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”NUMBER”,
”value”: ”Valt värde”
}

Taggar

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”TAGS”,
”value”: [”tagg1”, ”tagg2”]
}

Boolesk

{
”id”: ”Fältets id”,
”name”: ”Fältets namn”,
”type”: ”TOGGLE”,
”value”: ”Ja eller nej - fritextsträng”
}

Geometrier

Under egenskapen ”geometry” kan en eller flera geometrier listas beroende på objekttyp. Om objektet har flera geometrier så sammanfogas dessa i en GeometryCollection.
Den kan alltså se ut på två olika sätt enligt exempel nedan.

Single geometry

"geometry":{
"type":"MultiPolygon",
"coordinates":[
[619548.055704311,6917131.368104064],[619531.7116535523,6917104.258981411],[619534.0864301582,6917073.063846069],[619510.3386640984,6917045.326106079],[619540.65198901,6917024.503156795],[619502.8790717006,6917016.117517933],[619497.1516692981,6916992.701522135], [619548.055704311,6917131.368104064]
]
}

Multiple geometry

"geometry":{
"type":"GeometryCollection",
”geometries”: [
{
"type":"MultiPolygon",
"coordinates":[
[619548.055704311,6917131.368104064],[619531.7116535523,6917104.258981411],[619534.0864301582,6917073.063846069],[619510.3386640984,6917045.326106079],[619540.65198901,6917024.503156795],[619502.8790717006,6917016.117517933],[619497.1516692981,6916992.701522135], [619548.055704311,6917131.368104064]
]
},
{
"type":"MultiPolygon",
"coordinates":[
[619548.055704311,6917131.368104064],[619531.7116535523,6917104.258981411],[619534.0864301582,6917073.063846069],[619510.3386640984,6917045.326106079],[619540.65198901,6917024.503156795],[619502.8790717006,6917016.117517933],[619497.1516692981,6916992.701522135], [619548.055704311,6917131.368104064]
]
}
]
}
I skrivande stund stöds geometrityperna MultiPolygon, Point och LineString.

Säkerhetsklassning

Säkerhetsklass 0

Autentiseringsmetod: API Key

(Ref: Säkerhetsklassning av APIer )

API-ägare

Kultur och fritid

Friluftsenheten

Anders Erlandsson

anders.erlandsson@sundsvall.se

Teknisk ägare

Kultur och fritid

Friluftsenheten

Anders Erlandsson

anders.erlandsson@sundsvall.se

Länkar

<Länkar till dev-portal;

FAQ

<FAQ>