Meldescheine aktualisieren

Dokumentation unvollständig. 

Allgemein

Dieser Aufruf aktualisiert einen existierenden elektronischen Meldeschein im System.

Es kann pro Aufruf immer nur ein (1) Meldeschein aktualisiert werden.
Wenn im unten erläuterten Array mehrere Meldescheine aufgeführt sind, wird der erste Meldeschein (Index:0) aktualisiert.

Existierende Meldescheine müssen immer mindestens einen Gast besitzen. Es ist nicht möglich einen Meldeschein zu "leeren", indem alle Gäste gelöscht werden.

Parameter

POST import/meldeschein/aktualisieren/

 

Der Aufbau der Anfrage entspricht exakt des Aufrufs "buchen" mit dem Unterschied, dass im Meldeschein-Objekt die ID aus dem Aufruf "buchen" mit übergeben werden muss, um den zu aktualisierenden Meldeschein eindeutig zu identifizieren.

Zum aktualisieren von Gästen muss das Feld "id" mit übergeben werden

Server Antwort

Die "aktualisieren" Antwort enthält die ID des aktualisieren Meldescheins.Die Antwort ist unabhängig der ausgeführten Aktion immer im gleichen Format.

Da nur derzeit ein Meldeschein aktualisiert werden kann, befindet sich die ID des aktualisierten Meldescheins im Objekt response.meldescheine[0]

Um nach Veränderung  eines Meldescheins die aktuell hinterlegten Meldeschein-Daten abzurufen, verwenden Sie den Aufruf "get-data"

{
    "meta": {
        "requestId": "TEST",
        "timestamp": "2020-10-15T14:55:15.292144",
        "user": {
            "id": 38,
            "username": "DemoV",
            "alias": "Lisa Mustermann"
        },
        "gemeinde": 1
    },
    "status": "success",
    "response": {
        "meldescheine": [
            650
        ]
    }
}

Aktualisieren von vorhandenen Gästen  

Um Gäste zu aktualisieren, da sich z.B. Reisedaten geändert haben ist es notwendig, die "id" des Gastes mit zu übergeben.

Anlegen von zusätzlichen Gästen

Um dem Meldeschein weitere Gäste hinzuzufügen, können diese ohne Angabe des Feldes "id" in das "personen" Array mit übergeben werden.

Für das anlegen von zusätzlichen Gästen gelten die Regeln wie beim anlegen eines Meldescheins. Die Felder "tarif_id" , "arrival_date" sowie "departure_date" sind zwingend notwendig. Zusätzliche Felder analog zum buchen Aufruf und der eingerichteten Gemeinde.

Beispiel-Request: Anlegen eines zusätzlichen Gastes:

"Max Mustermann"
Tarif-ID "1" (Erwachsener)
Reisezeitraum: 15.10.2020 - 16.10.2020
in Meldeschein 650

{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId":"TEST"
  },
  "meldescheine": [
    {
			"id": 650,
			"personen":[
				{
					"arrival_date": "2020-10-15",
					"departure_date":"2020-10-16",
					"tarif_id":1,
					"Gast_Vorname":"Max",
					"Gast_Name":"Mustermann"
				}
			]
		}
  ]
}

Aktualisieren von vorhandenen Gästen 

Antwort:Um Gäste zu aktualisieren, da sich z.B. Reisedaten geändert haben ist es notwendig, die "id" des Gastes mit zu übergeben.
Diese kann z.B. über den   "get-data" Aufruf abgerufen werden oder kann beim buchen der Meldescheine sofort gespeichert werden.

Beispiel: Ändern des im vorherigen Beispiel "Anlegen von zusätzlichen Gästen" erzeugten Gastes "Max Mustermann":.

In diesem Fall wird der Reisezeitraum geändert: 16.10.2020 bis 19.10.2020 sowie der Nachname des Gastes.

Es werden nur Felder aktualisiert, die übergeben werden und im System vorhanden sind. Achten Sie daher bitte darauf, nur die notwendigen Felder zu übergeben und achten Sie auf korrekte Feldbezeichnungen 

Zu beachten die ID "1945"  des Gastes im unteren Beispiel.
- Wird die ID angegeben: Gast aktualisieren
- Keine Angabe der ID:  Gast anlegen

{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId": "TEST"
  },
  "timestamp"meldescheine": "2020-10-15T15:00:25.960902",
        "user":[
    {
			"id": 38,650,
			"username"personen": "DemoV",
            "alias": "Lisa Mustermann"
        },
        "gemeinde": 1
    },
    "status": "success",
    "response":[
				{
					"meldescheine"id":1945, //<------------------- ID des Gastes (z.B. über /get-data abgerufen
					"arrival_date": ["2020-10-16",
					650"departure_date":"2020-10-18",
					"tarif_id":1,
					"Gast_Vorname":"Max",
					"Gast_Name":"Mustermann (verändert)"
				}
			]
		}
  ]
}

 

 

Löschen von vorhandenen Gästen

Gäste können gelöscht werden, in dem diese mit ihrer ID sowie dem  Feld "delete:true" übergeben werden. 

Beispiel-Request: Löschen des Gastes mit id 1937 aus Meldeschein mit ID 651

{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId":"TEST"
  },
  "meldescheine": [
    {
			"id": 651,
			"personen":[
				{
					"id": 1937,
					"delete":true
				}
			]
		}
  ]
}

Wenn Sie versuchen einen Gast zu löschen, der nicht dem Schein zugeordnet ist, erhalten Sie eine entsprechende Fehlermeldung