delete

Belege > REST Resource: receipts.v2 > delete

post
delete

https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v2/delete
Entfernt einen epap aus der Datenbank und damit auch beim App Nutzer.
Request
Response
Request
Headers
Authorization
required
string
Access Token im Format Bearer [ACCESS_TOKEN], wobei [ACCESS_TOKEN] der im Login Vorgang generierte Token ist.
epap_id
required
string
Die interne Dokument-ID des zu entfernenden epaps. Diese ID kann aus dem Rückgabe-QR_Code des App Nutzers ausgelesen werden (in der App auf den epap gehen > Optionen ⠇> Rückgabe einleiten).
client_id
required
string
Die ID des Clients. Von epap vergeben.
chain_id
required
string
Die ID der anfragenden Handelskette. Dieser Wert muss mit dem entsprechenden Feld des epaps übereinstimmen, damit sichergestellt ist, dass eine Handelskette nur die eigenen Belege entfernen kann.
app_user_id
required
string
Die interne ID des App Nutzers. Diese ID kann aus dem Rückgabe-QR-Code des App Nutzers ausgelesen werden (in der App auf den epap gehen > Optionen ⠇> Rückgabe einleiten).
Response
200: OK
Der epap wurde erfolgreich aus der Datenbank entfernt und der App Nutzer wurde über die Entfernung informiert.
{
"message": "Successfully deleted receipt. The user has been notified about a deleted epap.",
"status": "OK",
"status_code": 200
}
400: Bad Request
Ein erforderlicher Parameter im Request Header fehlt, wobei [KEY] der Name des betreffenden Parameters ist.
{
"message": "Required key '[KEY]' in request headers is missing with no default. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Bad Request",
"status_code": 400
}
403: Forbidden
Mögliche Ursachen sind: • Die Client-ID ist unbekannt. • Der Access Token und damit die Authentifizierung ist abgelaufen. Zur weiteren Nutzung der Receipts API muss ein neuer Token generiert werden.
{
"message": "Value of key 'client_id' in request headers is unknown. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Forbidden",
"status_code": 403
}
{
"message": "Authorization for request has expired. Please generate a fresh access token. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Forbidden",
"status_code": 403
}
406: Not Acceptable
Mögliche Ursachen sind: • Der Wert eines Parameters im Request Header weist nicht den erwarteten Typ auf, wobei [KEY] der Name des betreffenden Parameters ist. • In der Datenbank befindet sich kein Dokument unter der angegebenen epap-ID. • Der Wert eines Parameters im Request Header stimmt nicht mit dem entsprechenden Feld des epaps überein.
{
"message": "Type of key '[KEY]' in request headers is not a string. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Not Acceptable",
"status_code": 406
}
{
"message": "Value of key 'epap_id' does not have a corresponding document. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Not Acceptable",
"status_code": 406
}
{
"message": "Value of key 'client_id', 'chain_id' or 'app_user_id' does not correspond to the epap document data. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Not Acceptable",
"status_code": 406
}
500: Internal Server Error
Ein interner Fehler bei der Verarbeitung der Request ist aufgetreten. In diesem Fall kontaktieren Sie bitte contact@epap.app.
{
"message": "An unknown error occured. Please contact us at contact@epap.app",
"status": "Internal Server Error",
"status_code": 500
}

Musteranfrage

curl --request POST "https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v2/delete" \
-H "Authorization: Bearer [ACCESS_TOKEN]" \
-H "epap_id: [EPAP_ID]" \
-H "client_id: [CLIENT_ID]" \
-H "chain_id: [CHAIN_ID]" \
-H "app_user_id: [APP_USER_ID]" \
-H "content-length: 0"

In dem obigen Beispiel ersetzen Sie [ACCESS_TOKEN] mit dem im Login Vorgang generierten Token, [CLIENT_ID] mit der Ihnen zugewiesenen Client-ID, [CHAIN_ID] mit der übereinstimmenden ID der Handelskette und [EPAP_ID] und [APP_USER_ID] mit den aus dem Rückgabe-QR-Code ausgelesenen Werten der internen Dokument-ID des epaps und der internen ID des App Nutzers.

Eine erfolgreiche Anfrage wird mit dem HTTP-Statuscode 200 OK beantwortet.

Beispielantwort

{
"message": "Successfully deleted receipt. The user has been notified about a deleted epap.",
"status": "OK",
"status_code": 200
}