Info

Utkast

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

Table of Contents

maxLevel	2
minLevel	1
include
outline	false
indent
exclude
type	list
printable	false
class

Dokumentversion 0.1

Gränssnittsdefinition

Åtkomstpunkt

...

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

...

Hämta uppslagsreferenser till attribut

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

...

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

...

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	nejincludeCrs	Inkludera CRS i svaret. Default: true	query	boolean	nej
format	WEAVE, FEATURE, FEATURE_COLLECTION. Default: FEATURE	query	string	nej

Svar

En GeoJSON Feature

Exempelsvar

...

Beskrivning

Skapa en ny post. Defaultvärden kan hämtas via GET /{edit}

Exempel

/edit.salesarea

Request-Body

Code Block

language	json

{
  "geometry": {
    "coordinates": [
      20.25,
      63.82
    ],
    "type": "Point"
  },
  "id": 160343,
  "type": "Feature",
  "properties": {
    "intern_id": "test1",
    "administration": 240,
    "operation": 302,
    "description": "En till laptopLaptop kvarlömd",
    "cost_prel": 3500,
    "damage_date": "2023-09-01",
    "status": 1,
    "policereport": false,
    "incident": false
  }
}

...

JSON med referens till skapad post

Exempelsvar

Code Block

language	json

{
  "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

Code Block

language	json

{
  "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
  }
}

...

JSON med referens till uppdaterad post

Exempelsvar

Code Block

language	json

{
  "id": "160352"
}

DELETE/{edit}/{id}

...

JSON med referens till raderad post

Exempelsvar

Code Block

language	json

{
  "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

Code Block

language	json

{
  "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

id

Postens id

parameter

Parametern att hämta värden för

path

string

ja

crs

query

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

...

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

Code Block

language	json

{
  "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 redigeringstjänster.

Exempelsvar

Code Block

language	json

[
  {
    "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

Code Block

language	json

{
  "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": "Datum",
      "dataType": "date",
      "allowBlank": false,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "policereport",
      "label": "Polisanmäld",
      "dataType": "string",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": false,
      "defaultValue": "0",
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "administration",
      "label": "Organisation",
      "dataType": "integer",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "list": true,
      "type": "scalar"
    },
    {
      "id": "operation",
      "label": "Avdelning",
      "dataType": "integer",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "list": true,
      "type": "scalar"
    },
    {
      "id": "categoriesandtype",
      "label": "Kategori och typ",
      "parameters": [
        {
          "id": "category",
          "label": "Kategori",
          "dataType": "integer",
          "allowBlank": true,
          "allowNew": false,
          "allowNull": true,
          "readonly": false,
          "readonlyOnInsert": false,
          "readonlyOnUpdate": false,
          "selectionList": [
            [
              65,
              "Fastighet"
            ],
            [
              66,
              "Försäkring"
            ]
          ],
          "type": "scalar"
        },
        {
          "id": "type",
          "label": "Typ",
          "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": "Beskrivning",
      "dataType": "string",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": true,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "intern_id",
      "label": "Intern-ID",
      "dataType": "string",
      "allowBlank": false,
      "allowNew": false,
      "allowNull": false,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "cost",
      "label": "Kostnad",
      "dataType": "integer",
      "allowBlank": true,
      "allowNew": false,
      "allowNull": true,
      "readonly": false,
      "readonlyOnInsert": false,
      "readonlyOnUpdate": false,
      "type": "scalar"
    },
    {
      "id": "status",
      "label": "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
    }
  }
}

Version	Old Version 1	New Version Current
Changes made by	Uffe Svensson	Uffe Svensson
Saved on	2023-10-02	2023-10-02

Content Comparison

Versions Compared

Key

Dokumentversion 0.1

Gränssnittsdefinition

Åtkomstpunkt

Svar

Exempelsvar

Beskrivning

Exempel

Request-Body

Exempelsvar

PUT /{edit}/{id}

Beskrivning

Exempel

Request-Body

Exempelsvar

DELETE/{edit}/{id}

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