Logo des Onlinedienstes Weinbau
API docs by Redocly

Onlinedienst Weinbau API (1.0.0)

Download OpenAPI specification:

E-mail: ticket@odweinbau.de License: Apache-2.0 Terms of Service

Spezifikation der API Schnittstelle des Onlinedienstes Weinbau.

Onlinedienst im Browser nutzen

Authentifizierung

Erstellen Sie über die Web-Oberfläche des Onlinediensts ein API-Token und verwenden Sie es in der Anfrage.

Begleitdokument

Begleitdokumente abrufen & einreichen

Abrufen eines einzelnen Begleitdokuments.

Abrufen eines einzelnen Begleitdokuments anhand seiner ID.

Authorizations:
oauthbearerAuth
path Parameters
id
required
string <uuid>

ID des Begleitdokuments, das abgerufen werden soll.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "49039a16-7cf6-4919-b501-c2764a268dd6",
  • "mvv_code": "DE-eRP-A000001",
  • "versanddatum": "2023-10-01",
  • "dienststelle": {
    },
  • "absender_betrieb_nr": "232426",
  • "empfaenger": {
    },
  • "erzeugnis": {
    },
  • "transport": {
    }
}

Abrufen aller Begleitdokumente.

Abrufen aller Begleitdokumente mit Paginierung und optionalen Filtern.

Authorizations:
oauthbearerAuth
query Parameters
perPage
integer
Default: 15

Anzahl der Elemente pro Seite.

page
integer
Default: 1

Nummer der aktuellen Seite.

absender
string

Filtert nach Treffern innerhalb der Betriebsnummer oder innerhalb der Adresse des Absenders (Name, Straße, PLZ, Ort, Land).

empfaenger
string

Filtert nach Treffern innerhalb der Betriebsnummer oder innerhalb der Adresse des Empfängers (Name, Straße, PLZ, Ort, Land).

erzeugnis
string

Filtert nach der Bezeichnung der Erzeugnisart, Rebsorten, Jahrgang, geografische Angaben oder traditioneller Begriff.

kommissionaer
string

Filtert nach Treffern innerhalb der Kommissionär-Adresse oder nach Betriebsnummer des Kommissionärs.

neu
boolean

Filtert nach Treffern entsprechend vorherigem Abruf durch die Betriebsnummer.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "string",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "path": "string",
  • "per_page": 2,
  • "prev_page_url": "string",
  • "to": 1,
  • "total": 1
}

Ein neues Begleitdokument einreichen.

Ein neues Begleitdokument einreichen.

Authorizations:
oauthbearerAuth
Request Body schema: application/json
required

Ein neues Begleitdokument einreichen.

One of
absender_betrieb_nr
string

Betriebsnummer des Absenders. Dieses Feld darf nur gefüllt werden, wenn Sie ein Kommissionär sind und der Betrieb Sie bereits über die Weboberfläche des Onlinedienstes als Kommissionär verknüpft hat.

absender_bundesland
string

Name des Bundeslands des Absenders. Darf nur zusammen mit dem Feld absender_betrieb_nr verwendet werden.

required
object

Angaben zum Empfänger des Begleitdokuments.

required
object (ErzeugnisCreate)

Angaben zum Erzeugnis

required
object

Angaben zum Transport.

Responses

Request samples

Content type
application/json
Example
{
  • "absender_betrieb_nr": "786170",
  • "absender_bundesland": "string",
  • "empfaenger": {
    },
  • "erzeugnis": {
    },
  • "transport": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "49039a16-7cf6-4919-b501-c2764a268dd6",
  • "mvv_code": "DE-eRP-A000001",
  • "versanddatum": "2023-10-01",
  • "dienststelle": {
    },
  • "absender_betrieb_nr": "232426",
  • "empfaenger": {
    },
  • "erzeugnis": {
    },
  • "transport": {
    }
}

Stammdaten

Wertelisten für die Felder der Begleitdokumente. Diese haben eine Gültigkeit von 24 Stunden, sodass die Listen für diesen Zeitraum zwischengespeichert werden können.

Abrufen der verfügbaren Erzeugnisarten.

Abrufen der verfügbaren Erzeugnisarten.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Herkunftsländer.

Abrufen der verfügbaren Herkunftsländer. Diese Liste ist für die Herkunftsangabe gedacht, nicht für Adresssen. Für Länder in Adressen verwenden Sie bitte den Endpunkt /stammdaten/land.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren geschützten Ursprungsbezeichnungen.

Abrufen der verfügbaren geschützten Ursprungsbezeichnungen.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren geschützten geografischen Angaben.

Abrufen der verfügbaren geschützten geografischen Angaben.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Bereichsangaben.

Abrufen der verfügbaren Bereichsangaben.

Authorizations:
oauthbearerAuth
path Parameters
ursprung
required
string <uuid>

ID des Ursprungs, für die die Bereichsangaben abgerufen werden sollen.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Grosslagen.

Abrufen der verfügbaren Grosslagen.

Authorizations:
oauthbearerAuth
path Parameters
ursprung
required
string <uuid>

ID des Ursprungs, für die die Bereichsangaben abgerufen werden sollen.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Ortsangaben.

Abrufen der verfügbaren Ortsangaben.

Authorizations:
oauthbearerAuth
path Parameters
ursprung
required
string <uuid>

ID des Ursprungs, für die die Bereichsangaben abgerufen werden sollen.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Einzellagen.

Abrufen der verfügbaren Einzellagen.

Authorizations:
oauthbearerAuth
path Parameters
ursprung
required
string <uuid>

ID des Ursprungs, für die die Bereichsangaben abgerufen werden sollen.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Traditionellen Begriffe.

Abrufen der verfügbaren Traditionellen Begriffe.

Authorizations:
oauthbearerAuth
path Parameters
herkunftstyp
required
string
Enum: "gu" "gga"

Typ der Herkunft (g.U., g.g.A.)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Ergänzungen zu den Traditionellen Begriffen.

Abrufen der verfügbaren Ergänzungen zu den Traditionellen Begriffen.

Authorizations:
oauthbearerAuth
path Parameters
herkunftstyp
required
string
Enum: "gu" "gga"

Typ der Herkunft (g.U., g.g.A.)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Weinarten.

Abrufen der verfügbaren Weinarten.

Authorizations:
oauthbearerAuth
path Parameters
herkunftstyp
required
string
Enum: "gu" "gga"

Typ der Herkunft (g.U., g.g.A.)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Weinbauzonen.

Abrufen der verfügbaren Weinbauzonen.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Länder für Adressen.

Abrufen der verfügbaren Länder für Adressen. Diese Liste ist nicht für die Herkunftsangabe gedacht, verwenden Sie für Länder in Herkunftsangaben bitte den Endpunkt /stammdaten/herkunftsland.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen der verfügbaren Kn Codes.

Abrufen der verfügbaren Kn Codes.

Authorizations:
oauthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Fehlertypen

Fehlertypen

HTTP Status Typ Beschreibung
400 bad-request Die Anfrage ist fehlerhaft. Zum Beispiel könnte ein Parameter ungültig sein oder fehlen.
401 unauthenticated Der Benutzer ist nicht authentifiziert. Bitte melden Sie sich an, um auf diese Ressource zuzugreifen.
403 unauthorized Der Benutzer ist nicht authorisiert, um auf diese Ressource zuzugreifen.
403 forbidden Der Benutzer hat keine Berechtigung, um auf diese Ressource zuzugreifen.
404 resource-not-found Die angeforderte Ressource wurde nicht gefunden.
404 route-not-found Die angeforderte URL existiert nicht auf dem Server.
405 method-not-allowed Die verwendete HTTP-Methode wird für diese URL nicht unterstützt.
409 conflict Konflikt mit der aktuellen Ressource, z.B. doppelte Einträge oder Inkonsistenzen.
422 validation-error Die Anfrage konnte nicht verarbeitet werden, da sie fehlerhafte Daten enthält. Die Details der Validierungsfehler werden im Response-Body bereitgestellt.
500 internal-server-error Unerwarteter Fehler auf dem Server. Bitte wenden Sie sich an den Support.
503 service-unavailable Der Server oder Dienst ist derzeit nicht erreichbar. Bitte versuchen Sie es später erneut.
520 about:blank Ein unbekannter Fehler ist aufgetreten.