GanjoorRelatedPerson

get a single kinship edge by its own id, with both sides' names resolved - used by /SuggestPersonRelationEdit/{relationId} to show what it's about

Changed on
get/api/people/relations/{relationId}

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

relationIdinteger required

Response

OK

idinteger

record id

person1Idinteger

first person in the relation - for a directional relation type (Parent, Ancestor) this is the parent/ancestor side; for a symmetric one (Sibling, Spouse) order doesn't matter

person2Idinteger

second person in the relation - for a directional relation type (Parent, Ancestor) this is the child/descendant side

relationType0 | 1 | 2 | 3

the kind of kinship edge a GanjoorPersonRelation represents between two GanjoorRelatedPerson rows. The graph is not a strict tree - siblings can be known without their parents, an ancestor can be known without the exact number of generations in between, etc. - so this is a small, deliberately open set rather than a rigid parent/child-only model.

degreeHintinteger nullable

for RelationType == Ancestor, an optional known exact degree (e.g. 2 for "grandparent", 3 for "great-grandparent") - left null when only the relative order is known, not the exact number of generations in between. Not used for other relation types.

notestring nullable

free-text note (e.g. sourcing/reasoning for this relation)

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status