Document Webservice für die Heizkostenabrechnung

Übermittelt Dokumente zwischen den Kundensystemen und ista

Diese API bietet eine Möglichkeit, Dokumente und Datensätze zwischen Messdienstunternehmen und Hausverwaltungen über einen Webservice auszutauschen.

  • Abfrage einer Liste der zum Abruf bereitstehenden Dokumente der Hausverwaltung
  • Übertragung einer maximalen Anzahl von Listeneinträgen für Dokumente/Datensätze, begrenzt auf 100.
  • Die _links-Struktur beinhaltet einen Blätter-Algorithmus im HATEOS Format. Für den Abruf der nächsten 100 Einträge der Liste ist der Link beispielsweise im next-Element angegeben.
  • Der Anrufer ist die Hausverwaltung.

Hinweise:

Die Schnittstelle dient lediglich als Kanal und gibt keine fachlichen Rückmeldungen zu Inhalten.
Dabei werden beide Kommunikationsrichtungen berücksichtigt.

Die Richtung Messdienstunternehmen zu Hausverwaltung wird im Dienst als `OUT` bezeichnet.
Die Richtung von der Hausverwaltung zum Messdienstunternehmen wird als `IN` bezeichnet.

 Alle Serviceabrufe sind für die Hausverwaltung als rufende Partei und die Messdienstunternehmen als Anbieter des Dienstes definiert.

Quelle: https://bved.info

Document Webservice Beispiel-Szenario

Übermittelt Dokumente zwischen den Kundensystemen und ista.
 

Verarbeitungshindernisse

Berechtigungen und Datenschutz

  • Die API erfordert eine Authentifizierung per OAuth 2.
  • Falls die Authentifizierung fehlschlägt, wird die Anfrage mit 401 Unauthorized abgelehnt.
  • Der Zugriff auf Abrechnungsdaten ist nur für autorisierte Benutzer möglich.
  • Falls der Benutzer keine Berechtigung für die angeforderte Abrechnungseinheit besitzt, wird die Anfrage mit 403 Forbidden abgelehnt.
  • Die API setzt voraus, dass eine vertragliche Vereinbarung zwischen Property Manager (PM) und Messdienstleister (MSC) besteht.