PGVWiki - User contributions [en]

GEDCOM REST Web Service API

2009-12-10T01:20:56Z

Wgroleau: Convert H3 into === to take advantage of Wiki features

<h1 >This page is under construction</h1>

Table of Contents
==Introduction==
The CGI gedcom access protocol provides a means whereby remote clients can access and manipulate genealogical data stored in phpGedView. This document describes the protocol remote clients use to communicate with phpGedView version .

A client communicates by making a POST or GET request to phpGedView through the file client.php. Every request must include an "action". An "action" tells phpGedView what type of request you want to make. The file client.php will respond with the string "SUCCESS" on the first line followed by the requested information or it will return an error message. Error messages always take the following form:

ERROR #: Error Message

Error message example:

ERROR 1: No action specified.

You may use the "version" and "listgedcoms" actions without a connection. All other actions require that you first send a "connect" action. The "connect" action can take a username and password if you want to have full access, or it can connect anonymously. A successful "connect" action will respond with a session name and session id that must accompany all future requests. You can specify which gedcom you want to work with at any time by sending the optional "ged" parameter with any request. All subsequent requests will use this gedcom until another "ged" parameter is specified.

The "actions" available through the protocol, their required parameters, and their responses are listed in the table below:
([tab] represents a single tab character)

==Protocol Actions==
From the browser window, or from a tcp/ip connection you will need to type in an action followed by the command such as:
http://localhost/pgv/client.php?action=version or
http://localhost/pgv/client.php?action=connect
For any command you can run a GET on you can also use a POST on. See the tables below for more detailed list of commands. 
===version===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="100%" colspan="2" bgcolor="#008080" height="37">
Protocol Actions</td>
</tr>
<tr>
<td width="50%" height="19">
"version" Action Request</td>
<td width="50%" height="19">
"version" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get the PhpGedView version. 
 
Required Parameters: 
action=versionSample URL: 
client.php?action=version</td>
<td width="50%" height="19" valign="top">Returns the version for
this installation of PhpGedView.Successful Response: 
SUCCESS version number 
Sample Response:
<table border="3" cellpadding="1" cellspacing="0" style="border-collapse: collapse" bordercolor="#651289" width="80%">
<tr><td>SUCCESS 4.1.6 svn </td></tr></table>
</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===listgedcoms===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%">

<tr>
<td width="50%" height="19" valign="top">
"listgedcoms" Action Request</td>
<td width="50%" height="19" valign="top">
"listgedcoms" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get a list of all of
the gedcoms available on this server.  Could be used to
allow the user to switch between gedcoms.Required Parameters: 
action=listgedcoms 
sessionname=sessionid
Sample URL: 
client.php?action=listgedcoms 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns a tab delimited
list of gedcom files and their corresponding titles.  Each
gedcom is written on its own line.Successful Response: 
SUCCESS 
gedcomfile1 [tab] title1 
gedcomfile2 [tab] title2 
...
Sample Response: 
SUCCESS 
surname.ged [tab] Surname Genealogy 
myfamily.ged [tab] My Family History</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===connect===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%">
<tr>
<td width="50%" height="19">
"connect" Action Request</td>
<td width="50%" height="19">
"connect" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Initiates a session
with the server. 
 
Required Parameters: 
action=connect 
 Optional paramters: 
username=username 
password=password 
ged=gedcom.ged 
readonly=1If no gedcom is specified with the "ged" parameter then the default gedcom defined by the PhpGedView
system administrator will be used. If no username and password are sent, then an anonymous read-only
connection will be established. Any attempts to change the data will result in an error. If the
"readonly" parameter is sent, then all editing features will be disabled and they will return errors. 
Sample URL: 
client.php?action=connect&username=admin&password=adminpass&ged=gedcom.ged 
Sample Anonymous Read-only connection:
client.php?action=connect&ged=gedcom.ged</td>
<td width="50%" height="19" valign="top">Returns the session
name and session id for this connection.Successful Response: 
SUCCESS 
sessionname [tab] sessionid
Sample Response: 
SUCCESS 
PHPSESSID [tab] f0c56ab7e2381cf17ce7c94135c1398b</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===get===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"get" Action Request</td>
<td width="50%" height="19" valign="top">
"get" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get one or more gedcom
records with the given "xref" ids from the gedcom file. 
The "xref" parameter accepts a semicolon delimetted list of xref
ids.Required Parameters: 
action=get 
xref=gedcomid 
sessionname=sessionid
Sample URL (single xref): 
client.php?action=get&xref=I100 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
Sample URL (multiple xref): 
client.php?action=get&xref=I100;I101 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns the raw gedcom
record for the given "xref".Successful Response: 
SUCCESS 
gedcom records 
...
Sample Response: 
SUCCESS 
0 @I100@ 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 
0 @I101@ INDI 
1 NAME Sibling /Surname/ 
1 BIRT 
2 DATE 1 Jan 1902 
2 PLAC New York, New York, USA 
...</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===getxref===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"getxref" Action Request</td>
<td width="50%" height="19" valign="top">
"getxref" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get the first, last,
next, or previous xref in the given type list.  A position
of "new" will create a new GEDCOM record for the given type. 
A position of "all" will return a list of allRequired
Parameters: 
action=getxref 
type=INDI|FAM|SOUR|REPO|NOTE|OBJE|OTHER 
position=new|first|next|prev|last|all 
xref=gedcomid 
sessionname=sessionid
Sample URL: (get the first FAM) 
client.php?action=getxref&type=FAM&position=first 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
Sample URL: (get the next INDI after I100) 
client.php?action=getxref&type=INDI&position=next&xref=I100 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
Sample URL: (get the xref for a new FAM. See also the
"append" action) 
client.php?action=getxref&type=FAM&position=new 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns a list of xref
Successful Response: 
SUCCESS 
XREF 
...
Sample Response: 
SUCCESS 
I102 
...</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===getvar===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"getvar" Action Request</td>
<td width="50%" height="19" valign="top">
"getvar" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get the value of the
given global phpGedView variable.  A list of available
variable names can be found in the config_gedcom.php file.
Required Parameters: 
action=getvar 
var=variablename 
sessionname=sessionid
Sample URL: 
client.php?action=getvar&var=GEDCOM 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns the value of
the global variable specified in "var".Successful Response: 
SUCCESS 
variable value
Sample Response: (in this example the current working gedcom) 
SUCCESS 
surname.ged</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===update===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"update" Action Request</td>
<td width="50%" height="19" valign="top">
"update" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Update a GEDCOM record
by replacing it by the given gedcom record.Required
Parameters: 
action=update 
xref=gedcomid 
gedrec=Raw GEDCOM Record 
sessionname=sessionid
Sample URL: 
client.php?action=update&xref=I100 
&gedrec=0 @I100@ INDI\n1 NAME New Name /Surname/\n 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns "SUCCESS".
Successful Response: 
SUCCESS
Sample Response: 
SUCCESS</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===append===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"append" Action Request</td>
<td width="50%" height="19" valign="top">
"append" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Append a new GEDCOM
record to this gedcom file.  (See also action=getxref&position=new)
Required Parameters: 
action=append 
gedrec=raw GEDCOM record 
sessionname=sessionid
Sample URL: 
client.php?action=append&gedrec=0 @NEW@ INDI\n1 NAME New Name
/Surname/\n&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns "SUCCESS" and
the new xref assigned to this gedcom record.Successful
Response: 
SUCCESS 
XREF
Sample Response: 
SUCCESS 
I9999</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===delete===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"delete" Action Request</td>
<td width="50%" height="19" valign="top">
"delete" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Deletes the GEDCOM
record from the file.Required Parameters: 
action=delete 
xref=gedcomid 
sessionname=sessionid
Sample URL: 
client.php?action=update&xref=I100 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns "SUCCESS".
Successful Response: 
SUCCESS
Sample Response: 
SUCCESS</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===getnext===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"getnext" Action Request</td>
<td width="50%" height="19" valign="top">
"getnext" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get the next gedcom
record after the given "xref" from the gedcom file.Required
Parameters: 
action=getnext 
xref=gedcomid 
sessionname=sessionid
Sample URL: 
client.php?action=getnext&xref=I100 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns the raw gedcom
record after the given "xref".Successful Response: 
SUCCESS 
gedcom record
Sample Response: 
SUCCESS 
0 @I99@ INDI 
1 NAME Given Names /Surname/ 
1 GIVN Given Names 
1 SURN Surname 
1 BIRT 
2 DATE 1 Jan 1880 
2 PLAC New York, New York, USA</td>
</tr>

</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===getprev===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"getprev" Action Request</td>
<td width="50%" height="19" valign="top">
"getprev" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get the previous gedcom
record before the given "xref" from the gedcom file.Required
Parameters: 
action=getprev 
xref=gedcomid 
sessionname=sessionid
Sample URL: 
client.php?action=getprev&xref=I100 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns the raw gedcom
record before the given "xref".Successful Response: 
SUCCESS 
gedcom record
Sample Response: 
SUCCESS 
0 @I101@ INDI 
1 NAME Given Names /Surname/ 
1 GIVN Given Names 
1 SURN Surname 
1 BIRT 
2 DATE 1 Jan 1920 
2 PLAC New York, New York, USA</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===search===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"search" Action Request</td>
<td width="50%" height="19" valign="top">
"search" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Use regular expressions
to search gedcom INDI records.Required Parameters: 
action=search 
query=keyword or expression 
sessionname=sessionid
Sample URL: (search for all indis with "arizona" in their
record) 
client.php?action=search&query=arizona 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
Sample URL: (search for all indis with an event in 1900) 
client.php?action=search&query=DATE+.*+1900 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns a sorted list
of INDI xrefs.Successful Response: 
SUCCESS 
XREF 
...
Sample Response: 
SUCCESS 
I1 
I100 
I102 
...</td>
</tr>

</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===soundex===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"soundex" Action Request</td>
<td width="50%" height="19" valign="top">
"soundex" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Use soundex to search
INDI names.Required Parameters: 
action=soundex 
firstname=givenames 
lastname=lastname 
sessionname=sessionid
Sample URL: (search for indis with soundex surname matching "finlay") 
client.php?action=soundex&lastname=finlay 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
Sample URL: (search for indis with soundex surname matching "finlay"
and firstname matching "john") 
client.php?action=soundex&lastname=finlay&firstname=john 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b</td>
<td width="50%" height="19" valign="top">Returns a sorted list
of INDI xrefs.Successful Response: 
SUCCESS 
XREF 
...
Sample Response: 
SUCCESS 
I1 
I100 
I102 
...</td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===uploadmedia===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"uploadmedia" Action Request</td>
<td width="50%" height="19" valign="top">
"uploadmedia" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Upload media files to
the PhpGedView server.  You can specify either a "mediafile"
a "thumbnail" or both.Required Parameters: 
action=uploadmedia 
mediafile=[File Data] 
thumbnail=[File Data] 
sessionname=sessionid
Sample URL: 
This cannot be done through a GET.  The data must be posted
in Multi-part mime form data.
 </td>
<td width="50%" height="19" valign="top">Returns a URL to the
uploaded object.Successful Response: 
SUCCESS 
http://www.yoursite.com/phpGedView/media/object 
http://www.yoursite.com/phpGedView/media/thumbs/object
Sample Response: 
SUCCESS 
http://www.yoursite.com/phpGedView/media/object 
 </td>
</tr>
</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

===getchanges===
<table border="3" cellpadding="2" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="99%" id="AutoNumber1">
<tr>
<td width="50%" height="19" valign="top">
"getchanges" Action Request</td>
<td width="50%" height="19" valign="top">
"getchanges" Action Response</td>
</tr>
<tr>
<td width="50%" height="19" valign="top">Get a list of changes since the given date.  Required Parameters: 
action=getchanges 
date=DD MMM YYYY 
sessionname=sessionid
Sample URL: 
client.php?action=getchanges&date=1+FEB+2006 &PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b

</td>
<td width="50%" height="19" valign="top">Returns a list of the changed record XREFs.
Successful Response: 
SUCCESS 
I101 
I102 
F51
 </td>
</tr>

</table>
<table width="99%">
<tr>
<td width="100%" height="19" colspan="2" valign="top" bgcolor="#C0C0C0"> </td>
</tr>
</table>

==Sample Communications==
Sample Communication The following is an example communication:
CLIENT: 
client.php?action=connect&username=admin&password=adminpass
SERVER: 
PHPSESSID [tab] f0c56ab7e2381cf17ce7c94135c1398b
CLIENT: 
client.php?action=getvar&var=PEDIGREE_ROOT_ID&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
SERVER: 
I1
CLIENT: 
client.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: 
client.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@
(The next few requests show how to switch from one gedcom to another) 
CLIENT: 
client.php?action=listgedcoms&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
SERVER: 
surname.ged [tab] Surname Genealogy 
myfamily.ged [tab] My Family History
CLIENT: (notice the GEDCOM parameter) 
client.php?GEDCOM=myfamily.ged&action=getvar&var=PEDIGREE_ROOT_ID 
&PHPSESSID=f0c56ab7e2381cf17ce7c94135c1398b
SERVER: 
I103
CLIENT: 
client.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@
 

==Errors==
<table border="1"><tr><th>Error</th><th>Description</th></tr>
<tr>
<td>ERROR 1: No action specified.</td>
<td>You will receive this error if no action was given on the URL. You can also receive this error if the URL is malformed.</td>
</tr>
<tr>
<td>ERROR 2: Unable to process request. Unknown action.</td>
<td>You will get this error when the action supplied is not one of the valid actions.</td>
<tr>
<td>ERROR 3: No gedcom id specified. Please specify a xref.</td>
<td>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.</td>
</tr>
<tr>
<td>ERROR 4: Could not find gedcom record with xref</td>
<td>The xref ID you specified does not match any record in this gedcom.</td>
</tr>
<tr>
<td>ERROR 5: GEDCOM file is not writable. Unable to complete request.</td>
<td>You will get this error if the appropriate write permissions have not been set on the gedcom file on the filesystem.</td>
</tr>
<tr>
<td>ERROR 6: Unable to open GEDCOM file resource. Unable to complete request.</td>
<td>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.</td>
</tr>
<tr>
<td>ERROR 7: Unable to write to GEDCOM file.</td>
<td>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.</td>
</tr>
<tr>
<td>ERROR 8: No gedcom record provided. Unable to process request.</td>
<td>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.</td>
</tr>
<tr>
<td>ERROR 10: Username and password key failed to authenticate.</td>
<td>The username and password supplied for the connect command failed to authenticate. This means that the password was incorrect
or the username is invalid.</td>
</tr>
<tr>
<td>ERROR 11: No write privileges for this record.</td>
<td>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.</td>
</tr>
<tr>
<td>ERROR 12: use 'connect' action to initiate a session.</td>
<td>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.</td>
</tr>
<tr>
<td>ERROR 13: Invalid variable specified. Please provide a variable.</td>
<td>You will get this error during the 'getvar' action if the variable name supplied in the 'var' parameter is not a valid variable.
</td>
</tr>
<tr>
<td>ERROR 15: No query specified. Please specify a query.</td>
<td>This error means that you did not send a 'query' parameter with the 'search' action.</td>
</tr>
<tr>
<td>ERROR 16: No names specified. Please specify a firstname or a lastname.</td>
<td>You will receive this error if the 'firstname' and 'lastname' parameters are missing in the 'soundex' action.</td>
</tr>
<tr>
<td>ERROR 17: Unknown position reference. Valid values are first, last, prev, next.</td>
<td>This error occurs when and invalid 'position' parameter was sent during the 'getxref' action.</td>
</tr>
<tr>
<td>ERROR 18: Invalid $type specification. Valid types are INDI, FAM, SOUR, REPO, NOTE, OBJE, or OTHER</td>
<td>You will get this error in the 'getxref' action if the 'type' parameter is not one of the valid gedcom types.</td>
</tr>
<tr>
<td>ERROR 19: Upload Error</td>
<td>You will get an ERROR 19 if an error occured during the file upload for the "uploadmedia" action.</td>
</tr>
<tr>
<td>ERROR 20: Invalid GEDCOM 5.5 format.</td>
<td>You will recieve this error if you supplied a gedcom record that does not have the basic structure of a level 0 gedcom record</td>
</tr>
<tr>
<td>ERROR 21: No Gedcoms available on this site.</td>
<td>This error occurs if you are trying to connect to a PhpGedView site that does not have any Gedcoms imported.</td>
</tr>
<tr>
<td>ERROR 22: Gedcom [$GEDCOM] needs to be imported.</td>
<td>This error occurs if you are trying to access a gedcom that has not yet been imported in PhpGedView.</td>
</tr>
<tr>
<td>ERROR 23: Invalid date parameter. Please use a valid date in the GEDCOM format DD MMM YYYY.</td>
<td>This error occurs if you have sent and invalid date. Dates should be specified using the GEDCOM 5.5 standard.</td>
</tr>
</table>

 <div align="center">Copyright © 2008 PhpGedView Team Members</div>

EVENT OR FACT CLASSIFICATION

2008-11-24T02:36:17Z

Wgroleau:

EVENT_OR_FACT_CLASSIFICATION:= {Size=1:90}

A descriptive word or phrase used to further classify the parent event or attribute tag.  This should be
used whenever either of the generic EVEN or FACT tags are used.  The value of this primitive is
responsible for classifying the generic event or fact being cited.  For example, if the attribute being
defined was one of the persons skills, such as woodworking, the FACT tag would have the value of
‘Woodworking,’ followed by a subordinate TYPE tag with the value ‘Skills.’
1 FACT Woodworking
2 TYPE Skills
This groups the fact into a generic skills attribute, and in particular this entry records the fact that this
individual possessed the skill of woodworking.  Using the subordinate TYPE tag classification method
with any of the other defined event tags provides a further classification of the parent tag but does not
change the basic meaning of the parent tag.  For example, a MARR tag could be subordinated with a
TYPE tag with an EVENT_DESCRIPTOR value of `Common Law.'
1 MARR
2 TYPE Common Law
This classifies the entry as a common law marriage but the event is still a marriage event.  Other
descriptor values might include, for example, ‘stillborn’ as a qualifier to BIRTh or ‘Tribal Custom’ as a
qualifier to MARRiage.

NAME TYPE

2008-11-24T02:17:21Z

Wgroleau: added missing section

NAME_TYPE:= {Size=5:30}
[ aka | birth | immigrant | maiden | married | <user defined>]
Indicates the name type, for example the name issued or assumed as an immigrant.
aka = also known as, alias, etc.
birth = name given on birth certificate.
immigrant = name assumed at the time of immigration.
maiden = maiden name, name before first marriage.
married = name was persons previous married name.
user_defined = other text name that defines the name type.

See [[PERSONAL_NAME_STRUCTURE]] for comments on PhpGedView support for name types.

PERSONAL NAME STRUCTURE

2008-11-24T02:11:59Z

Wgroleau: Add missing part and some discussion about it.

The [[PERSONAL NAME STRUCTURE]] organizes the names or names of a specific individual.

PERSONAL_NAME_STRUCTURE: =
n NAME <[[NAME_PERSONAL|NAME_PERSONAL]]> {1:1}
+1 TYPE <[[NAME_TYPE]]> {0:1}
+1 NPFX <[[NAME_PIECE_PREFIX|NAME_PIECE_PREFIX]]> {0:1}
+1 GIVN <[[NAME_PIECE_GIVEN|NAME_PIECE_GIVEN]]> {0:1}
+1 NICK <[[NAME_PIECE_NICKNAME|NAME_PIECE_NICKNAME]]> {0:1}
+1 SPFX <[[NAME_PIECE_SURNAME_PREFIX|NAME_PIECE_SURNAME_PREFIX]]> {0:1}
+1 SURN <[[NAME_PIECE_SURNAME|NAME_PIECE_SURNAME]]> {0:1}
+1 NSFX <[[NAME_PIECE_SUFFIX|NAME_PIECE_SUFFIX]]> {0:1}
+1 <<[[SOURCE_CITATION|SOURCE_CITATION]]>> {0:M}
+2 <<[[NOTE_STRUCTURE|NOTE_STRUCTURE]]>> {0:M}
+2 <<[[MULTIMEDIA_LINK|MULTIMEDIA_LINK]]>> {0:M}
+1 <<[[NOTE_STRUCTURE|NOTE_STRUCTURE]]>> {0:M}

Note that GEDCOM technically only allows one nickname.  If you do have more than one, however, PhpGedView will display all of them.  But only the first will be displayed in quotes in the full name line.

As an alternative to the “standard” of
1 NAME Jane /Doe/
2 TYPE married
PhpGedView also supports the extension
1 _MARNM Jane /Doe/

The former will be shown at the top of the record with the type beneath (see the [[NAME_TYPE|link]] for other types).&nbp; The latter will be displayed in the list of facts.

[[Category:GEDCOM]]
[[Category:Gedcom Structures]]

[[fr: STRUCTURE IDENTITE]]

Adding an individual

2007-11-18T21:32:58Z

Wgroleau: move ref to a better spot

Before starting off, it is usually a good idea to accept/reject any pending changes before adding new people.

There are various ways to add people:

== Add a new person that is related to an existing person: ==

('''See also:''' [[Creating relationships]])

## Most commonly you want to add relatives to an existing person in your family tree. New people will be linked by their relation to another individual as mother, father, wife, sibling ...etc.
## To do this, go to the individual page of ther person you want to add a new relative to. (You can go to the individual page for any person by clicking on their name.) For example if you want to add a father to "John Doe", you would first go to John Doe's individual page.
## Click on the "Close Relatives" tab
## Click on the link to "Add a new Father" [[Image:addfather.jpg]]
## If you scroll down to the bottom of the page, you will see many other links for adding new people:[[Image:addrelatives.jpg]]

== If you are working with a new GEDCOM … ==

If you are working with a new GEDCOM created by PhpGedView, an individual can be defined by changing the name of the root person (Individual 1 i.e. the node I1).
## Click on "Lists"->"Individual List"
## Change the name of the root individual by clicking on (in the Options for Individual box on the right) "Edit Name". That should give you your the first person. This doesn't have to be the patriarch or the one who started the family. Just something to begin with.[[Image:editname.jpg]]
## If you want to change many things at once, select the "Quick Edit" option.

== Add an unlinked individual ==

see [[Add an unlinked person]] for details.

[[fr:Ajouter un individu]]
[[Category:Users Guide]]
[[Category:PhpGedView]]

How To:Add existing father without having to edit GEDCOM

2007-11-18T21:19:16Z

Wgroleau: How To:Add existing father without having to edit GEDCOM moved to Creating relationships: Content enhanced. New title is shorter and more descriptive.

#REDIRECT [[Creating relationships]]