GAganjoor
GanjoorRelatedPerson

get the poems tagged with this person

Changed on
get/api/people/{id}/poems

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

idinteger required

Query parameters

catIdinteger

optional: only poems under this category (and its subcategories)

Response

OK

idinteger

Id

poemIdinteger

Poem Id

coupletIndexinteger

couplet index: 0 based like GanjoorVerse.CoupletIndex (0 is the first couplet), or RMuseum.Models.Ganjoor.PoemGeoDateTag.WholePoem (-1) if the tag applies to the whole poem

locationIdinteger nullable

location

lunarYearinteger nullable

Hijri Ghamari year

lunarMonthinteger nullable

Hijri Ghamari month

lunarDayinteger nullable

Hijri Ghamari day

lunarDateTotalNumberinteger nullable

sample: 14440101, would be used in sorting events

verifiedDateboolean

verified date

ignoreInCategoryboolean

ignore in category

personIdinteger nullable

related person id

personMention0 | 1

why a person is named in a tagged couplet/poem (PoemGeoDateTag.PersonMention): is the person actually part of the story/context being told, or only mentioned in passing? Needed to tell "poems where this person appears" from "poems that merely refer to them", e.g. when building presence and lifetime charts. Stored as int; new values can be appended later.

machineGeneratedboolean

AI generated

notestring nullable

optional explanatory note for this tag (e.g. why this couplet is relevant to the tagged person - carried over from the suggestion's SuggestionNote when a moderator approves it, and editable afterwards like the tag's other fields)

coupletTextstring nullable

the tagged couplet's own text (both مصرع of the verse at PoemId/CoupletIndex), filled in on read by whichever service method needs to show it (e.g. GanjoorRelatedPersonService.GetPoemsByPersonAsync) - not a mapped database column

Example response

[
  {
    "poem": {
      "cat": {
        "poet": {
          "rImage": {
            "folderName": "2017-08",
            "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
          }
        },
        "rImage": {
          "folderName": "2017-08",
          "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
        }
      },
      "ganjoorMetre": {
        "rhythm": "مفاعیلن مفاعیلن فعولن",
        "name": "\r\n            هزج مسدس محذوف\r\n            "
      }
    }
  }
]

Changes

  • 330e7bb195c1Revision changes
    • info

      added the new optional query request parameter catId

    • info

      added the optional property // to the response with the status

  • 285a0385568dRevision changes
    • info

      added the optional property / to the response with the status