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

Design

Lösningsbeskrivning

Gliffy
imageAttachmentIdatt325419042
macroId57449e4b-488a-42bf-a65b-e16eb54d0ea3
baseUrlhttps://sundsvall.atlassian.net/wiki
nameOePstatusAPI
diagramAttachmentIdatt325550093
containerId325484559
timestamp1632480282074

Statusar som hanteras (Open ePlatform)

  • Inskickat

  • Klart

  • Kompletterad

  • Sparat ärende

  • Under behandling

  • Väntar på komplettering

  • Ä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

Under behandling

UTSKICK

Under behandling

UNDER

Under behandling

KOMP

Väntar på komplettering

KOMP1

Väntar på komplettering

KOMPL

Kompletterad

KOMPBYGG

Kompletterad

KOMPTEK

Kompletterad

KOMPREV

Kompletterad

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

Expand
titleAPI-nyckel för sandbox-miljö. Klicka på "Authorize" nedan och ange denna nyckel för att testa API:et.

Kommer snart

Swagger ui
openapi: 3.0.1
info:
  title: CaseStatus
  version: '1.0'
servers:
  - url: https://api-test.sundsvall.se/caseStatus/1.0
paths:
  '/api/{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/{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 Dynasty

För tekniska frågor: teamdynasty@sundsvall.se

Länkar

<Länkar till dev-portal;

  • Test

  • Sandbox

  • Produktion>

FAQ

<FAQ>