Web Api Verzeichnis
Detail
Über die Detail API können erweiterte Informationen zu einem Insolvenzverfahren abgerufen werden. Je nach bestehendem Vertrag werden nicht alle Felder innerhalb der Antwort zurückgeliefert.
| API | Beschreibung |
|---|---|
| GET api/Detail/GetPublications?insolvencyId={insolvencyId}&packageId={packageId} |
Liefert eine Liste von Beschlüssen zu einem Insolvenzverfahren zurück. |
| GET api/Detail/GetStates?insolvencyId={insolvencyId}&packageId={packageId} |
Liefert eine Liste von der Verfahrenstermine zu einem Insolvenzverfahren zurück. |
| GET api/Detail/GetInsolvency?insolvencyId={insolvencyId}&packageId={packageId} |
Liefert die Details zu einem bereits bekannten Insolvenzverfahren zurück. |
Authentication
In der Authentication API befinden sich alle Calls, welche für das erzeugen eines Security Tokens notwendig ist, welches zur Kommunikation Ihrer Software mit der Insolvenz-API nötig ist.
| API | Beschreibung |
|---|---|
| GET api/Authentication/GetSessionId?applicationId={applicationId}&developerId={developerId} |
The get session id. |
| GET api/Authentication/GetToken?applicationId={applicationId}&developerId={developerId}&sessionId={sessionId} |
Über den GetToken API-Call wird, nachdem der Benutzer sich auf der Insolvenz-API Seite au-thentifiziert hat, ein gültiges Token eingeholt. Dieses gilt dann in Zukunft für die Authentifizie-rung mit dem Insolvenz-API Dienst. Das Token kann jederzeit im Insolvenz-API Administrati-onsbereich gesperrt werden, so dass die Anwendung nicht mehr mit der Insolvenz-API kom-munizieren kann. |
Finding
Innerhalb der Finding API befinden sich API-Calls, welche Sie zum Suchen von Insolvenz-Daten benutzen können. Je nach bestehendem Vertrag werden nicht alle Felder innerhalb der Antwort zurückgeliefert.
| API | Beschreibung |
|---|---|
| GET api/Finding/GetCourtList?packageId={packageId} |
Liefert eine Liste von Gerichten zurück, welche für den FindByFileLabel Call benötigt wird. |
| GET api/Finding/FindByFileLabel?fileLabel={fileLabel}&courtId={courtId}&packageId={packageId} |
Über den FindByFileLabel-Call können Sie nach Insolvenzen innerhalb der Insolvenz-Portal Daten suchen. |
| GET api/Finding/FindByName?searchType={searchType}&name={name}&zip={zip}&city={city}&street={street}&streetNumber={streetNumber}&packageId={packageId} |
Firmen anhand des Firmen-Namens, der PLZ oder Ortsnamen, sowie optional der Straße und Hausnummer suchen. |
Test
In der Test Api befinden sich Calls zum Testen der Verbindung
| API | Beschreibung |
|---|---|
| GET api/Test/ConnectionTest?testString={testString} |
Liefert den als Parameter übergebenen String zurück |
| GET api/Test/GetDateTime |
Liefert die aktuelle Serverzeit zurück |
Alert
Mittels der Alert API können Sie sich anhand von Suchmerkmalen über neue Verfahren informieren lassen.
| API | Beschreibung |
|---|---|
| POST api/Alert/AddAlertByTradeRegister?packageId={packageId} |
Fügt eine Überwachung eines Handelsregister Eintrags zu den Alerts hinzu. |
| DELETE api/Alert/RemoveFromAlert?alertId={alertId}&packageId={packageId} |
Entfernt eine einzelne Überwachung aus der Überwachungsliste. |
| GET api/Alert/GetAlertList?packageId={packageId} |
Liefert eine Liste der Überwachung nach Suchmerkmalen zurück. |
| GET api/Alert/Check?packageId={packageId} |
Liefert eine Liste mit Insolvenz-IDs zurück, welche Aufgrund der Suchmerkmale einen Treffer ergeben haben. |
| POST api/Alert/Acknowledge?packageId={packageId} |
The acknowledge. |
Watch
Über die Watch API haben Sie alles in der Hand, um einzelne Verfahren zu überwachen.
| API | Beschreibung |
|---|---|
| POST api/Watch/AddToWatchList?packageId={packageId} |
Fügt ein einzelnes Verfahren zu der Überwachungsliste hinzu. |
| DELETE api/Watch/RemoveFromWatchList?insolvencyId={insolvencyId}&packageId={packageId} |
Entfernt ein einzelnes Verfahren aus der Überwachungsliste. |
| GET api/Watch/GetWatchList?packageId={packageId} |
Liefert eine Liste der überwachten Verfahren zurück. |
| GET api/Watch/Check?packageId={packageId} |
Liefert eine Liste mit Insolvenz-IDs zurück, in welchen es Änderungen im Datensatz gab. |
| POST api/Watch/Acknowledge?packageId={packageId} |
The acknowledge. |