Home: Genealogy:

Get Database Record in XML: Help

This page describes the use of the script getRecordXml.php which is used to extract the content of database records in eXtensible Markup Language (XML).

The user must be signed in as a user to use this feature. The contents of the response to a request depends upon the level of authorization of the requesting user. In particular a requesting user can only see information that the user is authorized to see. For example private information about an individual in the family tree is only visible to members of that individual's family.

The record or records to be returned is specified by parameters passed by method "Get", that is by parameters passed as part of the Uniform Record Location (URL). The parameter names are case insensitive. For example you can specify "...?table=Picture" or "...?Table=Picture", "...&id=756" or "...&ID=756".

The table to be examined is identified by the parameter "table", which can have one of the following case-sensitive values:

Addresses This table contains records representing a fully structured address. For example this is used for the addresses of repositories. This table is implied if the IDAR parameter is specified. For further information see Addresses
PictureBases This table contains records representing a folder on the Web which contains images.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
Pictures This table contains records representing images.
Specific records are identified by parameters 'id'.
You can search for a list of address records by specifying the any of the following, "idir", "idtype", "pictype", "picorder", "picname", "picnameurl", "idbppic", "piccaption", "picd", "picsd", "picdate", "picdesc", "picprint", "picsoundname", "picsoundnameurl", "idbpsound", "used", "picpref", "filingref". For example "?table=Picture&idtype=0&idir=5" displays all pictures associated with individual 5.
ChildParentRels This table contains types of relationships between children and parents.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
Children This table contains records representing a child's relationship to a set of parents.
Specific records are identified by parameters 'id'.
You can search for a list of address records by specifying one or more of the following parameters. "idmr", "idir", "order", "prefchild", "idcs", "idcpdad", "idcpmom", "cpdadprivate", "cpmomprivate", "parseald", "parsealsd", "idtrparseal", "parsealnote", "ldsp", "templetag". For example specifying "?table=Child&idmr=6" lists all children in family 6. For example "?table=Child&idir=10939" lists all families in which individual 10939 is a child.
ChildStatuses This table contains records defining values of the field "idcs" in the Child table.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
DontMergeEntries This table contains records representing pairs of individuals who should never be merged because they are known to be distinct even though very similar in name and birth date.
Specific records are identified by parameters 'idirleft' and 'idirright'
Events This table contains records representing facts or events about an individual or a family.
Specific records are identified by parameters 'id'.
You can search for a list of event records by specifying one or more of the following parameters. "idir", "idet", "order", "eventd", "eventsd", "idlrevent", "desc", "gedtag", "eventexclude", "idtype", "idar", "description", "sentenceoverride", "qstag", "rgexclude", "kind", "ldstempleready", "preferred"
EventTypes This table contains records representing values of event type.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
Bookmarks This table contains records representing bookmarks.
Specific records are identified by parameters 'id'. There are always 200 entries in this table, numbered 1 through 200.
HistoryList This table contains records representing a history of the last 200 family tree individuals or families referenced by the system. This does not mean much when there are multiple users sharing the family tree so it is not maintained by the site.
Specific records are identified by parameters 'id'. There are always 200 entries in this table, numbered 1 through 200.
Header This table contains records representing information about the family tree database itself.
no parameters required. The complete table is always displayed.
Persons This table contains records representing individuals in the family tree.
Specific records are identified by parameters 'id'.
You can search for a list of location records by specifying one or more of the following parameters. "fsid", "surname", "soundslike", "givenname", "prefix", "title", "namenote", "gender", "birthd", "birthsd", "idlrbirth", "chrisd", "chrissd", "idlrchris", "chrterm", "deathd", "deathsd", "idlrdeath", "buriedd", "buriedsd", "idlrburied", "cremated", "idarbirth", "idarchris", "idardeath", "idarburied", "birthnote", "chrisnote", "deathnote", "buriednote", "living", "baptismd", "baptismsd", "baptismkind", "idtrbaptism", "baptismnote", "ldsb", "confirmationd", "confirmationsd", "confirmationkind", "idtrconfirmation", "confirmationnote", "ldsc", "initiatoryd", "initiatorysd", "idtrinitiatory", "initiatorynote", "ldsi", "endowd", "endowsd", "idtrendow", "endownote", "ldse", "templetag", "idmrpref", "idmrparents", "idar", "ancinterest", "decinterest", "tag1", "tag2", "tag3", "tag4", "tag5", "tag6", "tag7", "tag8", "tag9", "taggroup", "taganc", "tagdec", "savetag", "srchtag", "srchtagigi", "srchtagrg", "srchtagfs", "qstag", "remindertag", "remindertagdeath", "treenum", "ltmp1", "ltmp2", "alreadyused", "userref", "ancestralref", "notes", "references", "medical", "deathcause", "ppcheck", "imported", "added", "addedtime", "updated", "updatedtime", "relations", "nevermarried", "directline", "stmp1", "colortag", "intellishare", "private", "ppexclude", "rgexclude", "dna", "fssync", "fsdups", "fsordinance", "fslinks"
Locations This table contains records representing locations associated with events or facts.
Specific records are identified by parameters 'id'.
You can search for a list of location records by specifying one or more of the following parameters. "fsplaceid", "location", "used", "sortedlocation", "latitude", "longitude", "tag1", "shortname", "preposition", "notes", "verified", "fsresolved", "veresolved", "qstag", "zoom", "boundary".
Families This table contains records representing a family.
Specific records are identified by parameters 'id'.
You can search for a list of location records by specifying one or more of the following parameters. "idirhusb", "husborder", "husbprefmar", "husbsurname", "husbgivenname", "husbmarrsurname", "husbbirthsd", "idirwife", "wifeorder", "wifeprefmar", "wifesurname", "wifegivenname", "wifemarrsurname", "wifebirthsd", "marriednamerule", "idms", "mardc", "mard", "marsd", "marenddc", "marendd", "marendsd", "idlrmar", "marloc", "sealdc", "seald", "sealsd", "idtrseal", "sealloc", "sealnote", "ldss", "templetag", "tag1", "tag2", "tag3", "taggroup", "srchtag", "qstag", "remindertag", "notmarried", "nochildren", "alreadyused", "ltmp1", "ltmp2", "notes", "ppcheck", "added", "addedtime", "updated", "updatedtime", "idar", "hphrase", "wphrase", "rphrase", "rphrase2", "id", "tag4", "tag5", "tag6", "tag7", "tag8", "tag9", "userref", "mphrase", "sphrase", "husbwifeover1", "husbwifeover2", "wifehusbover1", "wifehusbover2", "private"
MarriageStatuses This table contains records representing the set of marriage statuses.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
Surnames This table contains records representing family names present in the database.
A specific record is identified by parameter 'surname=^surname$'.
You can search for a list of location records by specifying one or more of the following parameters. "surname", "soundslike", and "notes" use a pattern match. "used", "tag1", "qstag" are numeric values.
Names This table contains records representing individual names of individuals in the database.
A specific record is identified by parameter 'id=number'.
You can search for a list of name records by specifying one or more of the following parameters. "surname", "soundslike", "givenname", "prefix", "title", "userref", and "treename" are pattern matches. "idir", "order", "marriednamecreatedby", "birthsd", "preferredaka", "akanote", "idmr", "srchtag", and "qstag" are numeric values.
Reminders This table contains records representing reminders.
Specific records are identified by parameters 'id'.
Sources This table contains records representing documentary sources.
Specific records are identified by parameters 'id'.
You can search for a list of source records by specifying one or more of the following parameters. "srcname", "srctitle", "srcauthor", "srcpubl", "srctext", "srcnote", "srctag", "srcexclude", "idst", "used", "psrcnote", "fsrcnote", "tsrcnote", "psrctext", "fsrctext", "tsrctext", "idar", "enteredsd", "filingref", "srccallnum", "verified", "published", "enteredd", "qstag", "srcmpub", "srcrollnum", "templateid", "contents", "usestandard", "idar2", "bibliography", "override", "overridefootnote", "overridesubsequent", "overridebibliography". For example "?table=Source&srcname=Census" lists all sources whose name includes the word "Census".
SourceTypes This table contains records representing types of sources.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
Citations This table contains records representing citations to sources.
Specific records are identified by parameters 'id'.
You can search for a list of source records by specifying one or more of the following parameters. "idsr", "idime", "type", "srcdetail", "srcsurety", "srcprint", "srcprintdetail", "srcprinttext", "srcdettext", "srcdetnote", "srcprintnote", "enteredd", "enteredsd", "filingref", "order", "used", "verified", "content", "override", "overridefootnote", "overridesubsequent", "overridebibliography".
ToDoCategories This table contains records representing categories of To-Do items.
Specific records are identified by parameters 'id'. If this is omitted the complete table is displayed.
ToDoEntries This table contains records representing actions to take in the future.
Specific records are identified by parameters 'id'.
ToDoLocalities This table contains records representing localities associated with To-Do items.
Specific records are identified by parameters 'id'.
Temples This table contains records representing LDS Temples at which ordinances take place.
Specific records are identified by parameters 'id'.
You can search for a list of source records by specifying one or more of the following parameters. "code", "code2", "temple", "templestart", "templeend", "used", "tag1", "qstag"
RemovedIndividuals This table contains records representing record numbers of individuals that are no longer in use.
Specific records are identified by parameters 'id'.
RemovedFamilies This table contains records representing record numbers of families that are no longer in use.
Specific records are identified by parameters 'id'.
Users This table contains representing registered users of the site. Only an administrator can view this table.
Specific records are identified by parameters 'id'.
You can search for a list of source records by specifying one or more of the following parameters. "username", "password", "shapassword", "email", "auth", "id", "options"
Blogs This table contains records representing blog entries associated with any record in the database.
Specific records are identified by parameters 'id'.
You can search for a list of source records by specifying one or more of the following parameters. "index", "datetime", "username", "bl_table", "keyname", "keyvalue", "text"
MethodistBaptisms This table contains records representing Baptism records, particularly as maintained by the Wesleyan Methodist Church in Canada.
Specific records are identified by parameters 'id'.
You can search for a list of source records by specifying one or more of the following parameters. "volume", "page", "district", "area", "givenname", "surname", "father", "mother", "residence", "birthplace", "birthdate", "baptismdate", "baptismplace", "minister", "idir"
Births This table contains records representing birth registrations.
Specific records are identified by parameters 'domain', 'year', 'regnum'
Deaths This table contains records representing death registrations.
Specific records are identified by parameters 'domain', 'year', 'regnum'
Marriages This table contains records representing marriage registrations.
Specific records are identified by parameters 'domain', 'year', 'regnum'
CountyMarriages This table contains records representing marriages registered in Ontario prior to confederation which use a different system of identification than those after confederation.
Specific records are identified by parameters 'Domain', 'Volume', 'ReportNo', 'ItemNo'
You can search for a list of source records by specifying one or more of the following parameters. "volume", "reportno", "domain"
CountyMarriageReports This table contains records representing annual reports from clergymen.
Specific records are identified by parameters 'Domain', 'Volume', 'ReportNo'.
You can search for a list of source records by specifying one or more of the following parameters. "volume", "domain"
Counties This table contains records representing counties within a state or province.
Specific records are identified by parameters 'domain', and 'code'
For further information see Counties
Townships This table contains records representing townships, towns, cities, and villages within a county for which there as a separate registrar of vital statistics.
Specific records are identified by parameters 'domain', 'county', and 'code'.
You can search for a list of source records by specifying one or more of the following parameters. Exact match to "domain", "county", "prov", "code". Partial match to "name".
Censuses This table contains records representing censuses that are supported for citations by transcriptions.
Specific records are identified by the parameter 'censusid'. All census records are displayed if no parameters are specified.
For further information see Censuses
Districts This table contains records representing enumeration districts into which a census is divided for administration.
Specific records are identified by parameters 'censusid', 'district'.
You can search for a list of districts by specifying one or more of the following parameters: "censusid", "name", "nom", "province", "population".
SubDistricts This table contains records representing enumeration divisions within a census.
Specific records are identified by parameters 'censusid', 'district', 'subdistrict', 'division'.
You can search for a list of source records by specifying one or more of the following parameters: "domain", "county"
Pages This table contains records representing individual pages within a census.
Specific records are identified by parameters "censusid", "district", "subdistrict", "division", "page".
You can search for a list of source records by specifying one or more of the following parameters: "censusid", "district", "subdistrict", "division", "page", "sched", "population", "image", "transcriber", "proofreader".
Census1851 These tables contain records transcribed from specific censuses.
Specific records are identified by parameters "district", "subdistrict", "division", "page", and "line". For pre-confederation (1867) censuses the "province" must also be specified, for example "&province=CW".
You can search for a list of source records by specifying any field names within the census. For example "?table=Census1881&givennames=John&surname=Smith". Some fields have special handling:
SurnameSoundex If this is a 4-character SOUNDEX code it is compared directly to the SurnameSoundex field in the record. Otherwise it is treated as a surname whose SOUNDEX code is computed before the search is performed.
GivenNames A loose search is performed for records whose given names field contains any of the strings consisting of the first two characters of any of the names in the value. For example "givennames=John William" will match any records with given names containing either "jo" or "wi".
Census1861
Census1871
Census1881
Census1891
Census1901
Census1906
Census1911
Census1916
Census1921
James Cobban Logo Contact Author
Home: Genealogy: