Spatial Redigering API
- Uffe Svensson
Utkast
Tjänsten är under utveckling och dokumentationen ska ses som ett utkast
Dokumentversion 0.1
Gränssnittsdefinition
Åtkomstpunkt
weave/services/viamap/v1/spatial/edit
Format
Data hämtas och lämnas i JSON-format.
Referenssystem
Koordinatreferenssystem varierar beroende på källa. Möjlighet av automatisk transformation finns.
Felmeddelande
Om ett fel uppstår skickas svar med en HTTP-felkod
Sammanfattning
Redigering
Hämta, uppdatera eller skapa poster
Operation | Beskrivning |
|---|---|
Hämta en post med id | |
Skapa en ny post | |
Uppdatera en post med id | |
Radera en post med id | |
Hämta standardvärden för en post |
Referens
Hämta uppslagsreferenser till attribut
Operation | Beskrivning |
|---|---|
Hämta listuppslag för en parameter |
Metadata
Information om tillgängliga redigeringar
Operation | Beskrivning |
|---|---|
Hämta referenser till tillgängliga redigeringstjänster | |
Hämta detaljer för en redigeringstjänst |
Operationer
GET /{edit}/{id}
Beskrivning
Hämta en post med id.
Exempel
/edit.salesarea/160343?crs=EPSG:4326&includeCrs=true
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
id | Postens id | path | string | ja |
crs | Referenssystem för koordinaterna i geometrin. Vid avvikande anropat referenssystem mot lagrat sker en transformation per automatik. Lämnas parametern tom görs ingen transformation. | query | string | nej |
Svar
En GeoJSON Feature
Exempelsvar
{
"crs": {
"type": "name",
"properties": {
"name": "urn:ogc:def:crs:EPSG::4326"
}
},
"geometry": {
"coordinates": [
20.262794063450837,
63.82522391577476
],
"type": "Point"
},
"id": 160343,
"type": "Feature",
"properties": {
"damage_type": 371,
"damage_category": 68,
"administration": 236,
"policereport": false,
"description": "Laptop kvarglömd",
"cost_prel": 10,
"damage_date": "2022-12-22",
"operation": 310,
"incident": false,
"status": 2
}
}
POST /{edit}
Beskrivning
Skapa en ny post. Defaultvärden kan hämtas via GET /{edit}
Exempel
/edit.salesarea
Request-Body
{
"geometry": {
"coordinates": [
20.25,
63.82
],
"type": "Point"
},
"type": "Feature",
"properties": {
"intern_id": "test1",
"administration": 240,
"operation": 302,
"description": "Laptop kvarlömd",
"cost_prel": 3500,
"damage_date": "2023-09-01",
"status": 1,
"policereport": false,
"incident": false
}
}Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
crs | Referenssystem för koordinaterna i geometrin. | query | string | nej |
Svar
JSON med referens till skapad post
Exempelsvar
{
"id": "160352"
}
PUT /{edit}/{id}
Beskrivning
Uppdatera en post med id. Enbart fält som ska uppdateras behöver komma med i anropet. Geometri är dock ett krav i nuläget och får inte lämnas tomt.
Exempel
/edit.salesarea/160343
Request-Body
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
id | Postens id | path | string | ja |
Svar
JSON med referens till uppdaterad post
Exempelsvar
DELETE/{edit}/{id}
Beskrivning
Radera en post med id
Exempel
/edit.salesarea/160343
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
id | Postens id | path | string | ja |
Svar
JSON med referens till raderad post
Exempelsvar
GET /{edit}
Beskrivning
Hämta standardvärden för en post
Exempel
/edit.salesarea
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
Svar
En GeoJSON Feature med default-värden för redigeringstjänsten
Exempelsvar
GET /list/{edit}/{parameter}
Beskrivning
Hämta listuppslag för en parameter
Exempel
/edit.salesarea/administration?query=st&matchtype=middle&start=1&limit=5
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
parameter | Parametern att hämta värden för | path | string | ja |
query | Söksträng för att filtrera resultatet | query | string | nej |
matchtype | Välj om söksträngen ska matchas mot listvärden. I början, mitten eller slutet. Tillgängliga värden: start, middle, end | query | string | nej |
start | För paging. Postens startnummer | query | integer | nej |
limit | För paging. Begränsa antal rader i svaret | query | integer | nej |
Svar
En GeoJSON Feature med default-värden för redigeringstjänsten
Exempelsvar
GET /providers
Beskrivning
Hämta referenser till tillgängliga redigeringstjänster
Exempel
/providers
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
entity | Begränsa till ett dataslag | query | string | nej |
Svar
En JSON-array med grundläggande metadata om tillgängliga redigeringstjänster.
Exempelsvar
GET /providers/{edit}
Beskrivning
Hämta detaljer för en redigeringstjänst
Exempel
/providers
Parametrar
Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
edit | Redigeringstjänstens id | path | string | ja |
Svar
En JSON-objekt med metadata om en specifik redigeringstjänst
Exempelsvar