Response Felder

Einleitung

Im Folgenden sind die Response Felder beschrieben (s. für jeden Endpunkt Reiter "Response"). Die Aufrufe mit Request Body sind der Postman-Dokumentation zu entnehmen:

Postman

Allgemein

Jede Antwort hat einen allgemeinen Teil (s. nachfolgend). Das Element "data" ist individuell für jeden Endpunkt (s. Reiter "Response" jedes Endpunkts).

Alle Endpunkte

OPTIONS http://host/*

Siehe Reiter "Response"

Response Body

200 Allgemeiner Teil jeder Antwort. Gleich für alle Endpunkte.

{
    "success": War der Aufruf fehlerfrei; true wenn ja; false bei Fehlern,
    "code": Rückgabecode der API; 0 wenn fehlerfrei; für mögliche Rückgabecodes s. https://github.com/MarcinOrlowski/laravel-api-response-builder/blob/master/src/BaseApiCodes.php,
    "locale": Sprache der zurückgegebenen Nachricht; „de“ für Deutsch,
    "message": Nachricht mit dem Ergebnis der Verarbeitung; „OK“ wenn fehlerfrei,
    "data": {
        // zurückgegebene Daten, individuell für jeden Endpunkt
        // s. Beschreibung zum jeweiligen Endpunkt
    }    
}

Status

GET http://host/v1/status/:ticket

Path Parameters

Name	Type	Description
ticket	string	Externes Ticket ID (unique für jeden Aufruf)

200

{
    ...
    "data": {
        "status_type_id": Internes ID des Status Typs,
        "text": Beschreibung des aktuellen Standes bzw. nützliche Informationen,
        "data": Daten zum aktuellen Stand,
        "created_at": Zeitpunkt der Erstelltung des Eintrages mit dem Status für das Ticket,
        "updated_at": Zeitpunkt der letzten Änderung des Eintrages zum Status,
        "status_type": {
            "name": Titel des aktuellen Status,
            "description": Beschreibung des aktuellen Status,
            "comment": Kommentar zum aktuellne Status (optional)
        },
        "ticket": {
            // Metadaten zum Ticket
            // s. Endpunkt Ticket
        },
        "response": {
            // Metadaten zur Response
            // s. Endpunkt Response
        }
    }
}

Response

GET http://host/v1/response/:ticket

Hole die gelieferte Antwort von ELSTER

Path Parameters

Name	Type	Description
ticket	string	Externes Ticket ID (unique für jeden Aufruf)

200 Protokoll existiert mit folgenden Inhalt.

{
    ...
    "data": {
        "id": Internes ID der Antwort,
        "file_name": Dateiname,
        "file_content": Inhalt der Datei,
        "log_content": Inhalt der Log-Datei als Text (wenn in MySQL Datenbank vorhanden),
        "transfer_ticket": ID des Übermittlungsvorgangs bei der Finanzverwaltung (bei erfolgreicher Übermittlung aufgedruckt auf dem PDF-Übermittlungsprotokoll),
        "created_at": Zeitpunkt der Erstelltung des PDF-Übermittlungsprotokolls,
        "ticket": {
            // Metadaten zum Ticket
            // s. Endpunkt Ticket
        }
    }
}

Ticket

GET http://host/v1/ticket/:ticket

Hole Metadaten zum Ticket

Path Parameters

Name	Type	Description
ticket	string	Externes Ticket ID (unique für jeden Aufruf)

200

{
    ...
    "data": {
        "id": Internes Ticket ID (vergeben durch API),
        "ticket": Externes Ticket ID (unique für jeden Aufruf),
        "filing": Art der Meldung,
        "usecase": Anwendungsfall (validate oder send),
        "client_id": Externe Kunden ID (mitgegeben mit jedem Aufruf),
        "client_user": Externe Kennung des Kunden (z. B. Name oder Login; optional),
        "created_at": Zeitpunkt der Erstellung des Tickets
    }
}