2. Ressourcen

Alle API Endpoints werden mit Hilfe von Swagger dokumentiert. Über die entsprechenden URIs können alle Requests und Responses eingesehen und getestet werden.

Hinweise:

2.1. Aufträge anlegen

Über diese Schnittstelle können Aufträge automatisiert im System angelegt werden.

  • URI: https://besichtigungsauftrag.hypservice.de/Auftrag
  • HTTP-Verb: POST
  • Datenformat: JSON

2.1.1. Vertragsabhängige Einstellungen

Es gibt je nach Vertrag bei einzelnen Parametern spezifische Angaben und Einstellungen. Diese können einzeln abgerufen und für die Übermittlung des Auftrags verwendet werden.

  • Auftragsarten: https://besichtigungsauftrag.hypservice.de/auftragsart
  • Objektarten: https://besichtigungsauftrag.hypservice.de/objektart
  • Fristlevel: https://besichtigungsauftrag.hypservice.de/frist
  • Ansprechpartner: https://besichtigungsauftrag.hypservice.de/ansprechpartnertyp

2.2. Auftragsverlauf abrufen

Über die Schnittstelle kann der Bearbeitungsverlauf eines Auftrages abgerufen werden.

  • URI: https://besichtigungsauftrag.hypservice.de/auftragsverlauf/{idAuftrag}
  • HTTP-Verb: GET

2.2.1. Webhooks

Um exzessives Polling zu vermeiden, können wir die Informationen auch automatisch an ein externes System per POST senden bzw. das System nur informieren, dass Daten bereit liegen. So kann das externe System selbst entscheiden, wann Daten abgerufen werden. Bitte wenden Sie sich dazu an unseren Support unter support@hypservice.de.

2.3. Auftragsergebnisse abrufen

Über die Schnittstelle kann das Ergebnis (PDF) eines Auftrages abgerufen werden. Die Ergebnisse als Rohdaten folgt in einer kommenden Version.

  • URI: https://besichtigungsauftrag.hypservice.de/bericht/{idAuftrag}
  • HTTP-Verb: GET
  • RETURN: FileResult (Byte-Array)

2.3.1. Webhooks

Um exzessives Polling zu vermeiden, können wir die Informationen auch automatisch an ein externes System per POST senden bzw. das System nur informieren, dass Daten bereit liegen. So kann das externe System selbst entscheiden, wann Daten abgerufen werden. Bitte wenden Sie sich dazu an unseren Support unter support@hypservice.de.

2.4. Tickets stellen / Notizen senden

Kommunikation mit Hypservice zum Senden von ergänzenden Informationen zu einem Auftrag

  • URI: https://besichtigungsauftrag.hypservice.de/Auftrag/{id}/notiz
  • HTTP-Verb: POST

2.5. Aufträge stornieren

Auftrag stornieren

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/storno
  • HTTP-Verb: POST

2.6. Aufträge reklamieren

Auftrag reklamieren

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/reklamieren
  • HTTP-Verb: POST

2.7. Aufträge abrufen

Liefert eine bestimmte Menge an Besichtigungsaufträgen gefiltert nach Parametern (Invalide Parameter werden ignoriert)

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/
  • Parameter: Datum der Auftragserstellung, Datum des Auftragsabschlusses, abgeschlossen, Anzahl, Seite
  • HTTP-Verb: GET

2.8. Auftragsdetails abrufen

Auftragsdetails anhand der übergebenen Id

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}
  • HTTP-Verb: GET

2.9. Dokumente

2.9.1 Dokumente abrufen

Gibt eine Liste aller Dokumente zurück

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/dokumente
  • HTTP-Verb: GET

2.9.2 Dokumente hinzufügen

Fügt ein Dokument einem Auftrag hinzu

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/dokumente
  • HTTP-Verb: POST

2.9.3 Dokumente löschen

Entfernt ein Dokument

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/dokumente/{docid}
  • HTTP-Verb: DELETE

2.9.4 Dokumente downloaden

Ruft ein Dokument eines Auftrages als binary ab

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/dokumente/{docid}/download
  • HTTP-Verb: GET

2.9.5 Dokumententypen

Ruft alle für den Import möglichen Dokumententypen ab

  • URI: https://besichtigungsauftrag.hypservice.de/dokumenttyp
  • HTTP-Verb: GET

2.10. Ansprechpartner

2.10.1 Ansprechpartner hinzufügen

Fügt einen neuen ASP einem Auftrag hinzu

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/ansprechpartner
  • HTTP-Verb: POST

2.10.2 Ansprechpartner abrufen

Gibt alle ASP des Auftrages zurück

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/ansprechpartner
  • HTTP-Verb: GET

2.10.3 Ansprechpartner löschen

Entfernt einen ASP

  • URI: https://besichtigungsauftrag.hypservice.de/auftrag/{id}/ansprechpartner
  • HTTP-Verb: DELETE

Cookies helfen uns bei der Bereitstellung unserer Dienste. Durch die Nutzung unserer Dienste erklären Sie sich damit einverstanden, dass wir Cookies setzen. Mehr Informationen

The cookie settings on this website are set to "allow cookies" to give you the best browsing experience possible. If you continue to use this website without changing your cookie settings or you click "Accept" below then you are consenting to this.

Close