Skip to content

[v2] Vereinheitlichung serviceType vs. service zu publicService

Warum?

Für die Verwaltungsleistung werden in Submission API, Destination API und den Metadaten unterschiedliche Begriffe verwendet. Zur Verbesserung der Klarheit soll in Zukunft an allen bekannten (und noch nicht bekannten) Stellen der einheitliche Begriff publicService bzw. publicServices verwendet werden.

Relevante Links und Bemerkungen

Bekannte Stellen (ggf. ergänzen)

  • Destination API
    • In der RESPONSE bzw. im REQUEST BODY wird aus services publicServices. Das betrifft:
      • get /v2/destinations
      • post /v2/destinations
      • get /v2/destinations/{destinationId}
      • put /v2/destinations/{destinationId}
      • delete /v2/destinations/{destinationId}
      • patch /v2/destinations/{destinationId}
    • Das Schema DestinationServicewird entsprechend zu DestinationPublicService
  • Submission API
    • Bei get /v2/destinations/{destinationId} analog zur Destinatipon API wird in der RESPONSE aus services publicServices.
    • Bei post /v2/submissions wird in der RESPONSE bzw. im REQUEST BODY aus serviceType publicService.
    • Bei put /v2/submissions/{submissionId} wird in der RESPONSE aus serviceType publicService.

In der Zustellpunktverwaltung: services 

services:
- identifier: 'urn:de:fim:leika:leistung:99010003001006'
  submissionSchemas:
  - schemaUri: 'https://schema.fitko.de/fim/s00000121_1.0.0.schema.json'
    mimeType: application/json
  regions:
  - DE094750156156
  - DE09330411

In der Submission-Verwaltung (Submission API): serviceType 

serviceType:
  name: Bauantrag
  identifier: 'urn:de:fim:leika:leistung:99010003001006'

Im Metadatenschema: publicServiceType (deprecated as of #866 (closed)) bereits deprecated

publicServiceType:
  identifier: "urn:de:fjd:s03000025"
  name: "Antrag auf Feststellung einer Behinderung und Zuerkennung von Merkzeichen"
  description: "..."

Akzeptanzkriterien

  1. In der Destination API v2 wird publicServices verwendet (vgl. Bekannte Stellen)
  2. In der Submission API v2 wird bei GET destination publicServices und bei PUT / POST submission publicService verwendet (vgl. Bekannte Stellen)
  3. In der v2 des Metadatenschemas ist das abgekündigte Objekt publicServiceType nicht mehr enthalten

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

Edited by Fabian Sudau