* Achtung! Links, die mit * markiert sind, führen zu originalen englischen Seiten. Benutzen Sie anschließend immer den "zurück"-Knopf Ihres Browsers, um wieder auf die deutschen Seiten zu gelangen.
Rote Links zeigen an, dass die englische Original-Version ein neueres Datum hat, als die deutsche Übersetzung

1. Einleitung
2. Befehlsliste
1. version
2. listgedcoms
3. connect
4. get
5. getxref
6. getvar
7. update
8. append
9. delete
10. getnext
11. getprev
12. search
13. soundex
14. uploadmedia
3. Kommunikations-Beispiel
4. Fehlermeldungen

Einleitung
Mit dem CGI-Protokoll für den GEDCOM-Zugang steht ein Werkzeug zur Verfügung, mit dem Remote Clients auf in PhpGedView gespeicherte genealogische Daten zugreifen und sie verändern können. Dieses Dokument beschreibt das Protokoll, das Remote Clients benutzen, um mit PhpGedView 3.2 zu kommunizieren.

ERROR #: Fehlermeldung

Beispiel einer Fehlermeldung:

ERROR 1: No action specified.

Sie können die Befehle "version" und "listgedcoms" auch ohne vorherigen Verbindungsaufbau benutzen. Für alle anderen Befehle müssen Sie zuächst einmal den Befehl "connect" senden. Der Befehl "connect" benötigt einen Benutzernamen und ein Passwort, wenn Sie vollen Zugriff wünschen; andernfalls erfolgt eine anonyme Anmeldung. Eine erfolgreiche "connect action" wird mit einem Session-Namen und einer Session-ID beantwortet, die allen weiteren Anfragen hinzugefügt werden müssen. Sie können jederzeit angeben, mit welcher GEDCOM-Datei Sie arbeiten möchten, indem Sie den optionalen "ged"-Parameter mit Ihrer Anfrage schicken. Alle folgenden Anfragen werden diese GEDCOM-Datei benutzen, bis ein anderer "gedcom"-Parameter angegeben wird.

Die im Protokoll verfügbaren Befehle, ihre erforderlichen Parameter und ihre Antworten sind in der folgenden Tabelle aufgelistet.
([tab] bedeutet ein einzelnes Tabulator-Zeichen)
[Anm. d. Ü.: Von einer Übersetzung der Tabelle wurde abgesehen, da man wohl davon ausgehen kann, dass diejenigen, die mit dieser Materie vertraut sind, die Angaben auch so verstehen, und eine Übersetzung unnötig Verwirrung stiften würde.]

Kommunikations-Beispiel
Hier ein Beispiel für eine Kommunikation:

CLIENT:
gdbi.php?action=connect&username=admin&password=adminpass

SERVER:
PHPSESSID [tab] f0c56ab7e2381cf17ce7c94135c1398b

CLIENT:
gdbi.php?action=getvar&var=PEDIGREE_ROOT_ID&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

SERVER:
I1

CLIENT:
gdbi.php?action=get&xref=I1&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

SERVER:
0 @I1@ INDI
1 NAME Given Names /Surname/
1 GIVN Given Names
1 SURN Surname
1 BIRT
2 DATE 1 Jan 1900
2 PLAC New York, New York, USA
1 FAMS @F1@

CLIENT:
gdbi.php?action=get&xref=F1&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

SERVER:
0 @F1@ FAM
1 HUSB @I1@
1 WIFE @I2@
1 MARR
2 DATE 13 Jun 1921
2 PLAC New York, New York, USA
1 CHIL @I3@

(Die folgenden Anfragen zeigen, wie Sie die Gedcom-Datei wechseln können)
CLIENT:
gdbi.php?action=listgedcoms&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

SERVER:
surname.ged [tab] Surname Genealogy
myfamily.ged [tab] My Family History

CLIENT: (notice the GEDCOM parameter)
gdbi.php?GEDCOM=myfamily.ged&action=getvar&var=PEDIGREE_ROOT_ID
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

SERVER:
I103

CLIENT:
gdbi.php?action=get&xref=I103&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

SERVER
0 @I103@ INDI
1 NAME Given Names /Surname/
1 GIVN Given Names
1 SURN Surname
1 BIRT
2 DATE 1 Jan 1976
2 PLAC Hamburg, Germany
1 FAMS @F1@ 1 FAMS @F1@

Fehlermeldungen und Beschreibungen

Fehlermeldung	Beschreibung deutsch	Original-Beschreibung (englisch)
ERROR 1: No action specified.	Sie erhalten diese Fehlermeldung, wenn kein Befehl in der URL übergeben wurde, oder die URL falsch formatiert war (Syntaxfehler)	You will receive this error if no action was given on the URL. You can also receive this error if the URL is malformed.
ERROR 2: Unable to process request. Unknown action.	Der übergebene Befehl ist keine gültige Aktion.	You will get this error when the action supplied is not one of the valid actions.
ERROR 3: No gedcom id specified. Please specify a xref.	Der übergebene Befehl erfordert einen xref-Parameter, den Sie jedoch nicht angefügt haben.	You will get this error if you attempted to use an action that requires an xref parameter, but failed to supply the xref parameter on the URL.
ERROR 4: Could not find gedcom record with xref	Der übergebene xref-Parameter entspricht keiner der IDs der vorhandenen Datensätze dieser Gedcom-Datei.	The xref ID you specified does not match any record in this gedcom.
ERROR 5: GEDCOM file is not writable. Unable to complete request.	Für die Gedcom-Datei, die Sie bearbeiten bestehen keine Schreib-Rechte.	You will get this error if the appropriate write permissions have not been set on the gedcom file on the filesystem.
ERROR 6: Unable to open GEDCOM file resource. Unable to complete request.	Dieser Fehler sollte nur sehr selten auftreten und zwar dann, wenn das Betriebssystem des Servers die Gedcom-Datei nicht öffnen kann.	This error should be very rare and will only happen if the operating system on the server is unable to open the gedcom file for some reason.
ERROR 7: Unable to write to GEDCOM file.	Dieser Fehler sollte nur sehr selten auftreten und zwar dann, wenn das Betriebssystem des Servers die Gedcom-Datei nicht schreiben kann. Ein möglicher Grund ist, dass ein anderer Benutzer die Datei geöffnet hat.	This error should be very rare and will only happen if the operating system on the server is unable to write to the gedcom file. Possible reasons could be that another user on the system has the file open.
ERROR 8: No gedcom record provided. Unable to process request.	Der übergebene Befehl erfordert eine komplette Gedcom-Datensatz-Angabe, aber Sie haben den Parameter 'gedrec' nicht angefügt.	You will receive this error when the action requires that you provide a full gedcom record but no 'gedrec' parameter was found in the request.
ERROR 10: Username and password key failed to authenticate.	Der Benutzername oder das Passwort wurden falsch eingegeben. Dies bedeutet, dass entweder das Passwort falsch war, oder der Benutzername nicht existiert.	The username and password supplied for the connect command failed to authenticate. This means that the password was incorrect or the username is invalid.
ERROR 11: No write privileges for this record.	Sie haben versucht einen Datensatz zu bearbeiten, für den Sie keine Editier-Rechte haben, oder Sie befinden sich im nur-lesen-Modus.	You will receive this error if you try to edit a record that you don't have permission to edit, or if you try to edit in read-only mode.
ERROR 12: use 'connect' action to initiate a session.	Sie haben einen Befehl gesendet, ohne vorher die Verbindung mit dem 'connect'-Befehl anzumelden. Möglicherweise haben Sie auch zu lange keine Engabe getätigt und wurden automatisch abgemeldet.	You will receive this error if you try to use an action without first using the 'connect' action. You can also receive this error if your session timed out.
ERROR 13: Invalid variable specified. Please provide a variable.	Sie haben mit dem 'getvar'-Befehl eine Variable abgefragt aber der Variablenname im Parameter 'var' entspricht keiner gültigen Variable.	You will get this error during the 'getvar' action if the variable name supplied in the 'var' parameter is not a valid variable.
ERROR 15: No query specified. Please specify a query.	Sie haben den Befehl 'search' verwendet, aber nicht den erforderlichen 'query' Parameter angegeben.	This error means that you did not send a 'query' parameter with the 'search' action.
ERROR 16: No names specified. Please specify a firstname or a lastname.	Sie haben den Befehl 'soundex' gesendet aber die Parameter 'firstname' und 'lastname' wurden nicht angegeben. Geben Sie wenigstens einen dieser Parameter an.	You will receive this error if the 'firstname' and 'lastname' parameters are missing in the 'soundex' action.
ERROR 17: Unknown position reference. Valid values are first, last, prev, next.	Zum Befehl 'getxref' haben Sie einen ungültigen Parameter 'position' hinzugefügt. Gültige Werte sind: first, last, prev, next.	This error occurs when and invalid 'position' parameter was sent during the 'getxref' action.
ERROR 18: Invalid $type specification. Valid types are INDI, FAM, SOUR, REPO, NOTE, OBJE, or OTHER	Sie haben den Befehl 'getxref' gesendet, aber der übergebene Parameter 'type' ist keiner der gültigen Gedcom-Typen.	You will get this error in the 'getxref' action if the 'type' parameter is not one of the valid gedcom types.
ERROR 19: Upload Error	Es ist ein Fehler beim Datei-Upload während des Befehls "uploadmedia" aufgetreten.	You will get an ERROR 19 if an error occured during the file upload for the "uploadmedia" action.
ERROR 20: Invalid GEDCOM 5.5 format.	Sie haben einen Gedcom-Datensatz hinzugefügt, der in seiner Struktur kein zulässiger Level 0 Gedcom-Datensatz ist.	You will recieve this error if you supplied a gedcom record that does not have the basic structure of a level 0 gedcom record
ERROR 21: No Gedcoms available on this site.	Sie haben versucht eine Verbindung zu einer PhpGedView-Seite aufzubauen, bei der (noch) keine Gedcom-Dateien importiert sind.	This error occurs if you are trying to connect to a PhpGedView site that does not have any Gedcoms imported.
ERROR 22: Gedcom [$GEDCOM] needs to be imported.	Sie haben versucht auf eine Gedcom-Datei zuzugreifen, die noch nicht in PhpGedView importiert wurde.	This error occurs if you are trying to access a gedcom that has not yet been imported in PhpGedView.