lucid-check.md

Lucid-Prüfung

• Struktur der Schnittstelle
  • Methode
  • Eingabeparameter
  • Ausgabefelder
  • Statuscodes
• Beispiele
  • Gültige Lucid Id

Struktur der Schnittstelle

Die Struktur der API ist hier beschrieben

Methode

Für die Lucid-Prüfung muss lucidCheck als Methode angegeben werden

Eingabeparameter

Feld	Erwarteter Wert	Pflicht	Bedeutung
lucidId	String	Ja	Enthält die zu prüfende Registrierungsnummer des Lucid-Verpackungsregisters

Ausgabefelder

Feld	Erwarteter Wert	Pflicht	Bedeutung
predictions	Array	Ja	Enthält JSON-Objekte mit Korrekturvorschlägen.
predictions.lucidId	String	Ja	Enthält die formatierte Registrierungsnummer aus dem Lucid -Verpackungsregister
predictions.companyName	String	Ja	Enthält den Firmennamen zu diesem Vorschlag.
predictions.kindOfReferenceNumber	String	Ja	Enthält den Typ der Referenznummer vat: Umsatzsteuer-Identifikationsnummer tax: Steuernummer unknown: Unbekannt Firmenadresse zu diesem Vorschlag.
predictions.referenceNumber	String	Ja	Enthält die Referenznummer
predictions.packagingDetailCode	Int	Ja	Angabe, ob es Verpackungen mit Systembeteiligungspflicht sind 1: Verpackungen mit Systembeteiligungspflicht 2: Verpackungen ohne Systembeteiligungspflicht 3: beides 4: Unbekannt
status	Array	Ja	Enthält eine Liste aus Statuscodes, die den geprüften Datensatz beschreiben. Siehe Liste der Statuscodes.

Statuscodes

Code	Bedeutung
lucid_correct	Diese Registrierungsnummer ist im Lucid-Verpackungsregister bekannt
lucid_invalid	Diese Registrierungsnummer ist im Lucid-Verpackungsregister nicht bekannt

Beispiele

Gültige Lucid Id

Anfrage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "lucidCheck",
  "params": {
    "lucidId": "DE3151155944772"
  }
}

Antwort

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "predictions": [
      {
        "lucidId": "DE3151155944772",
        "companyName": "foodsbest GmbH",
        "kindOfReferenceNumber": "vat",
        "referenceNumber": "DE311849520",
        "packagingDetailCode": 1
      }
    ],
    "status": [
      "lucid_correct"
    ]
  }
}