Utkast

Tjänsten är under utveckling och dokumentationen ska ses som ett utkast

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
GET /{edit}/{id}	Hämta en post med id
POST /{edit}/{id}	Skapa en ny post
PUT /{edit}/{id}	Uppdatera en post med id
DELETE /{edit}/{id}	Radera en post med id
GET /{edit}	Hämta standardvärden för en post

Referens

Hämta uppslagsreferenser till attribut

Operation	Beskrivning
GET /list/{edit}/{parameter}	Hämta listuppslag för en parameter

Metadata

Information om tillgängliga redigeringar

Operation	Beskrivning
GET /providers	Hämta referenser till tillgängliga redigeringstjänster
GET /providers/{edit}	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
includeCrs	Inkludera CRS i svaret. Default: true	query	boolean	nej
format	WEAVE, FEATURE, FEATURE_COLLECTION. Default: FEATURE	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

Exempel

/edit.salesarea

Request-Body

{
  "geometry": {
    "coordinates": [
      20.25,
      63.82
    ],
    "type": "Point"
  },
  "id": 160343,
  "type": "Feature",
  "properties": {
    "intern_id": "test1",
    "administration": 240,
    "operation": 302,
    "description": "En till 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

Exempel

/edit.salesarea/160343

Request-Body

{
  "geometry": {
    "coordinates": [
      20.25,
      63.82
    ],
    "type": "Point"
  },
  "id": 160343,
  "type": "Feature",
  "properties": {
    "intern_id": "test1",
    "administration": 240,
    "operation": 302,
    "description": "En till 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
id	Postens id	path	string	ja

Svar

JSON med referens till uppdaterad post

Exempelsvar

{
  "id": "160352"
}

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

{
  "id": "160352"
}

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

{
  "type": "Feature",
  "properties": {
    "policereport": false,
    "incident": false,
    "status": "2"
  }
}

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

{
  "rows": [
    [
      234,
      "Infrastrukturbolaget AB"
    ],
    [
      238,
      "Stadsledningskontor"
    ],
    [
      239,
      "Stöd och omsorg"
    ],
    [
      240,
      "Teknik och fastighet"
    ],
    [
      245,
      "Konst och Museum AB"
    ]
  ],
  "total": 6,
  "success": true
}

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 regigeringstjänster

Exempelsvar

[
  {
    "id": "edit.salesarea",
    "label": "Säljområden",
    "entity": "entity.salesarea",
    "description": "Redigera regionala säljområden",
    "published": true,
    "creatable": true,
    "updatable": true,
    "deletable": false
  }
]

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

{
  "id": "edit.salesarea",
  "label": "Säljområden",
  "entity": "entity.salesarea",
  "description": "Redigera regionala säljområden",
  "published": true,
  "creatable": true,
  "updatable": true,
  "deletable": false,
  "parameters": [
    {
      "id": "created_date",
      "label": "%skfab_damage_date",
      "dataType": "date",
      "allowBlank": false,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "policereport",
      "label": "%skfab_police_report",
      "dataType": "string",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": false,
      "defaultValue": "0",
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "administration",
      "label": "%skfab_administration",
      "dataType": "integer",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "list": true,
      "type": "scalar"
    },
    {
      "id": "operation",
      "label": "%skfab_operation",
      "dataType": "integer",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "list": true,
      "type": "scalar"
    },
    {
      "id": "categoriesandtype",
      "label": "%skfab_damage_categories",
      "parameters": [
        {
          "id": "damage_category",
          "label": "%skfab_category",
          "dataType": "integer",
          "allowBlank": true,
          "allowNew": false,
          "allowNull": true,
          "readonly": false,
          "readonlyOnInsert": false,
          "readonlyOnUpdate": false,
          "selectionList": [
            [
              65,
              "Fastighet"
            ],
            [
              66,
              "Försäkring"
            ]
          ],
          "type": "scalar"
        },
        {
          "id": "damage_type",
          "label": "%skfab_type",
          "dataType": "integer",
          "allowBlank": true,
          "allowNew": false,
          "allowNull": true,
          "readonly": false,
          "readonlyOnInsert": false,
          "readonlyOnUpdate": false,
          "selectionList": [
            [
              353,
              "Brand",
              65
            ],
            [
              359,
              "Egendom",
              66
            ],
            [
              355,
              "Skadegörelse",
              65
            ]
          ],
          "type": "scalar"
        }
      ],
      "type": "cascade"
    },
    {
      "id": "description",
      "label": "%skfab_description",
      "dataType": "string",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": true,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "intern_id",
      "label": "%skfab_internal_id",
      "dataType": "string",
      "allowBlank": false,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "cost",
      "label": "%skfab_actual_cost",
      "dataType": "integer",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": true,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "status",
      "label": "%skfab_status",
      "dataType": "string",
      "allowBlank": false,
      "allowNew": false,
      "allowNull": false,
      "defaultValue": "2",
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "selectionList": [
        [
          1,
          "Mottagen"
        ],
        [
          2,
          "Registrerad"
        ],
        [
          3,
          "Strängd"
        ],
        [
          0,
          "Avbruten"
        ]
      ],
      "type": "scalar"
    }
  ],
  "geometry": {
    "geometry": {
      "maximum": 2147483647,
      "minimum": 0
    },
    "linestring": {
      "maximum": 0,
      "minimum": 0
    },
    "polygon": {
      "maximum": 0,
      "minimum": 0
    },
    "point": {
      "maximum": 1,
      "minimum": 1
    }
  }
}

Spatial Redigering API

Gränssnittsdefinition

Åtkomstpunkt

Format

Referenssystem

Felmeddelande

Sammanfattning

Redigering

Referens

Metadata

Operationer

GET /{edit}/{id}

Beskrivning

Exempel

Parametrar

Svar

Exempelsvar

POST /{edit}

Beskrivning

Exempel

Request-Body

Parametrar

Svar

Exempelsvar

PUT /{edit}/{id}

Beskrivning

Exempel

Request-Body

Parametrar

Svar

Exempelsvar

DELETE/{edit}/{id}

Beskrivning

Exempel

Parametrar

Svar

Exempelsvar

GET /{edit}

Beskrivning

Exempel

Parametrar

Svar

Exempelsvar

GET /list/{edit}/{parameter}

Beskrivning

Exempel

Parametrar

Svar

Exempelsvar

GET /providers

Beskrivning

Exempel

Parametrar

Svar

Exempelsvar

GET /providers/{edit}

Beskrivning

Exempel

Parametrar

Svar

Exempelsvar