Repository navigation
api4webtrees 1.13.0
API levels 21–24: places, media objects, start person. Everything is additive; older clients keep working.
- Level 21 – reading places.
GET Places?list=1: every place at visible events with counts (events, individuals,
families), coordinates (from the GEDCOM-L_LOCrecord, else webtrees' geographic data, elseMAPat an event, with
coordSource), the_LOCidentifier, GOV identifier and short name.GET Place?name=: the individuals and families
with their events there, places below,eventCounts(births, marriages, deaths, other) and the_LOCwith GOV
identifier, coordinates, postal code, region, country, short name, notes, sources and media. A place finds its_LOC
by the pointer at the event, the binding of the place-register module, the GOV identifier or a unique leaf name.
Privacy as everywhere: only visible events count; restricted records take the exact (slower) path. - Level 22 – writing places.
POST Place {name, gov?, lat?, lng?, note?, media?, postalCode?, region?, country?, shortName?, mapData?}writes into the_LOCand creates it if missing (_POST/POST,_STAE,_CTRY,
2 ABBRunder the name – existing spellings stay). With an ambiguous leaf name the events get3 _LOC @L…@.
mapData: truealso writes webtrees' geographic data (site administrators only). - Level 23 – renaming and merging places.
POST PlaceRename {from, to, preview?}: every event atfromgetsto,
places below move along. Iftoalready has records it is a merge: the two_LOCbecome one (gaps filled, notes,
sources and media appended, differing GOV identifier or coordinates reported). Locked or confidential events stay and
are counted.POST MediaObject {title?, type?}changes title and type of a media object; media now carry
type/format, at a_LOCalso file size and image dimensions.POST Media {media}links an existing media
object (edit rights suffice). NOTE facts namenoteXrefwhen they point to a shared note. - Level 24 – start person. Route Info names per tree
startXref– the individual webtrees starts with for this
user (own default individual, “this is me”, the tree's default individual, else the first) – and
treeDefaultXref.POST StartPerson {xref, forTree?}sets the user's own default individual (empty removes it) or,
for managers, the family tree's. - With SQLite (nas4webtrees, the family tree on this PC) webtrees can keep one place in two spellings that differ only
in case (“Celle”, “celle”); places count both, renaming takes both along. - Tests: places (reading, writing, renaming, merging, privacy), media objects, start person; performance check with
10,000 and 50,000 individuals (docs/leistung.md).