GAganjoor
GanjoorRelatedPerson

replace the aliases of a person (Auth policies: ganjoor:modify)

Changed on
put/api/people/{id}/aliases

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

aliasesstring nullable

names separated by ، (Persian comma), a comma or a new line

Response

OK

idinteger

id

namestring nullable

name

descriptionstring nullable

description

wikiUrlstring nullable

wikipedia url

birthYearInLHijriinteger

birth year in lunar hijri

deathYearInLHijriinteger

death year in lunar hijri

validBirthDateboolean

BirthYearInLHijri, for some poets it is only indicator of their century of birth and should not be relied as their valid birth date

validDeathDateboolean

DeathYearInLHijri, for some poets it is only indicator of their century of death and should not be relied as their valid death date

birthLocationIdinteger nullable

birth location id

deathLocationIdinteger nullable

death location id

machineGeneratedboolean

AI generated

familyTreeCaptionstring nullable

optional caption for the family tree this person is treated as the root of (e.g. "ساسانیان", "آل برمک") - purely a display label for whoever a tree is being browsed from; nothing enforces that this person actually has no recorded ancestors themselves, and most people will leave this null (only whichever person a tree is "named after" needs one set).

importance0 | 1 | 2

how editorially prominent a GanjoorRelatedPerson is treated as - purely a display/sizing hint (see GanjoorRelatedPerson.Importance, GanjoorPersonGraphNode.Importance and peoplegraph.js's nodeRadius()), never used to filter, rank or otherwise affect query results. New values can be appended safely later (stored as int).

gender0 | 1 | 2

a GanjoorRelatedPerson's gender - used only by the family-tree chart (familytree.js's buildLayout()) to break ties when a child has two recorded parents and both happen to have their own recorded ancestors (so neither side can be preferred on "continues a documented lineage" grounds alone): the father is preferred as the tree's spine parent, matching conventional patrilineal genealogy-chart practice, with the mother then drawn attached beside him. Never used to filter, rank or otherwise affect query results. New values can be appended safely later (stored as int).

aliasesstring nullable

other names this person is known by (epithets, titles, alternative spellings), separated by the Persian comma (،) - e.g. for رستم: «تهمتن، رستم دستان، پور زال». Used by the AI tagging jobs to match a name in a poem to this person, and filled automatically when two people are merged

Changes