GanjoorRelatedPerson

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

Changed on
get/api/people/affiliations/{affiliationId}

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

affiliationIdinteger required

Response

OK

idinteger

record id

person1Idinteger

first person in the tie - for a directional type (Minister, Advisor, Courtier, Patron) this is the one in the subordinate/serving role; for a symmetric one (Ally, Rival) order doesn't matter

person2Idinteger

second person in the tie - for a directional type this is the one being served

affiliationType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 99

the kind of non-family tie a GanjoorPersonAffiliation represents between two people - e.g. a minister serving a king, an advisor, a patron. Unlike PersonRelationType this has nothing to do with kinship; it's what lets two otherwise unrelated family trees show up as adjacent (e.g. "some Barmakids served the Abbasid court") without merging them into one tree. New values can be appended safely later (stored as int) as more cases come up.

notestring nullable

free-text note (e.g. sourcing/reasoning, or what the tie actually is when AffiliationType is Other)

Changes

    • warning

      added the new 15.00 enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status