Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
Ett standardiserat status-API (status ur intressentens perspektiv), som levererar resultatet på ett för OeP-optimerat format, så väl som på andra format.
Mer information: Hantera status från APIer i OeP
Livscykelstatus
DesignProduktion
Lösningsbeskrivning
| Gliffy |
|---|
|
|
|
Statusar som hanteras (Open ePlatform)
InskickatKlart
Tilldelat för handläggning
Under behandling
Komplettering behövs
Väntar på komplettering
Påminnelse om komplettering
Kompletterad
Komplettering inkommen, behandling fortsätter
Sparat ärende
Under behandling
Väntar på kompletteringBeslut finns, se separat information
Klart
Ärendet arkiveras
Mappning av status från CaseManagement
Status i CaseManagement (Byggr) | Status i Open ePlatform | nationell standard (förslag)* |
|---|---|---|
ANM | Inskickat | |
ANSÖKAN | Inskickat | |
Kv2 |
Tilldelat för handläggning | ||
UTSKICK | Under behandling | |
|---|---|---|
UNDER | Under behandling | |
KOMP |
Komplettering behövs | |
KOMP1 |
|---|
Påminnelse om komplettering | |
KOMPL |
|---|
Komplettering inkommen, behandling fortsätter | |
KOMPBYGG |
|---|
Komplettering inkommen, behandling fortsätter | |
KOMPTEK |
|---|
Komplettering inkommen, behandling fortsätter | |
KOMPREV |
|---|
Beslut finns, se separat information | ||
SLU | Klart | |
|---|---|---|
UAB | Klart | |
Avslutat | Ärendet arkiveras |
Temporär mappning av ECOS-ärenden. Detta krävdes för att verksamt.se skulle kunna utföra sin POC.
Status i CaseManagement (Ecos) | Status i Open ePlatform | nationell standard (förslag)* |
|---|---|---|
Anmälan | Inskickat | |
Begäran om komplettering | Väntar på komplettering | |
Komplettering | Kompletterad |
*Tjänstebeskrivning
Taget från ”Tjanstebeskrivning_Kundhandelser 1.0 Doc 0.991.pdf”:
”kundhandelskategori: Kategoriserar typen av händelse för att beskriva vad händelsen handlar om.
Möjliga värden (fastställs vecka 9-10):
Mottagningskvittens, Beslut, Föreläggande, Kompletteringsbegäran, Upplysning, Kallelse, Påminnelse, Förfrågan, Svar, Åtgärd krävs”
Hantering av personuppgifter
Ingen hantering av personuppgifter.
API specifikation
GET
casestatus/{version}/{flowInstanceID}/oepstatus
Returnerar aktuell status för ärende i ett format som kan läsas av OpenE.
Exempel - svar:
| Code Block |
|---|
{
"key" : "status",
"value" : "Inskickat"
} |
casestatus/{version}/{externalCaseID}/status
Returnerar aktuell status för ärende i ett format som kan läsas av OpenE.
Exempel - svar:
| Code Block |
|---|
{
"caseType" : "Nybyggnadskarta",
"id" : "123456",
"status" : "Inskickat",
"lastStatusChange" : "2022-02-02 16:00"
} |
casestatus/{version}/{organisationNumber}/statuses
Returnerar en array med statusar för alla ärenden kopplade till inskickat organisationsnummer.
Exempel - svar:
| Code Block |
|---|
[
{
"caseType" : "Nybyggnadskarta",
"id" : "123456",
"status" : "Inskickat",
"lastStatusChange" : "2022-02-02 16:00"
}
] |
Mappning av CaseData-ärenden för Mark och exploatering.
Status i CaseManagement (CaseData) | Status i Open ePlatform | nationell standard (förslag)* |
|---|---|---|
Ärende inkommit | Inskickat | |
Under granskning | Under behandling | |
Under utredning | Under behandling | |
Under beslut | Under behandling | |
Beslutad | Klart | |
Beslut verkställt | Klart | |
Ärende Avslutat | Klart | |
Väntar på komplettering | Väntar på komplettering | |
Komplettering inkommen | Kompletterad | |
Intern komplettering | Under behandling | |
Under remiss | Under behandling | |
Återkoppling remiss | Under behandling | |
Intern återkoppling | Under behandling |
Hantering av personuppgifter
Personnummer och organisationsnummer hanteras.
API specifikation
| Open api | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| caseStatus
| 1
|
paths:
'
| /{externalCaseId}/oepstatus':
get:
tags:
- CaseStatus
parameters:
- name: externalCaseId
in: path
required: true
style: simple
explode: false
schema:
type: string
format: string
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/oepstatus'
/api/test:
get:
tags:
- Test
parameters: []
responses:
'200':
description: ok
content:
application/json:
schema:
type: string
'/api/{organisationNumber}/statuses':
get:
tags:
- CaseStatus
parameters:
- name: organisationNumber
in: path
required: true
style: simple
explode: false
schema:
type: string
format: string
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/casestatus'
'/api/{externalCaseId}/status':
get:
tags:
- CaseStatus
parameters:
- name: externalCaseId
in: path
required: true
style: simple
explode: false
schema:
type: string
format: string
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/status'
security:
- ApiKeyAuth: []
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: apikey
schemas:
oepstatus:
type: object
properties:
key:
type: string
nullable: false
value:
type: string
nullable: false
status:
type: object
properties:
caseType:
type: string
nullable: false
id:
type: string
nullable: false
status:
type: string
nullable: false
lastStatusChange:
type: string
nullable: false
casestatus:
type: array
nullable: false
items:
$ref: '#/components/schemas/status'
| ||||||||||||||||
Säkerhetsklassning
Säkerhetsklass 1
Autentiseringsmetod: Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/API
Ansvarigt team: Team DynastyUnmasked
För tekniska frågor:teamdynasty@sundsvall teamunmasked@sundsvall.se
Länkar
<Länkar till dev-portal;
Test
Sandbox