Sign in
latestOpenAPI 3.0.42026-08-15482162872.3 KB

cc1652ba4704

Ganjoor

get a specific poem section

get/api/ganjoor/section/{sectionId}

Path parameters

sectionIdinteger required

Response

OK

idinteger

record id

poemIdinteger

Poem Id

poetIdinteger nullable

poet id might be different from GanjoorPoem.PoetId

indexinteger

use this field instead of Id for referencing to ease record deletion for verses, Index starts at 0, each poem should have at least one non-virtual part ordered by Index without break

numberinteger

for lots of poems Number equals to Index + 1, but for rare ones such as a paragraph containing multi-band poem this could be different, 0 means no visible numbers

sectionType0 | 1 | 2 | 3

poem section type

verseType1 | 2 | 3 | 4

how GanjoorPoemSection is linked to GanjoorVerse

ganjoorMetreIdinteger nullable

prosody information

ganjoorMetreRefSectionIndexinteger nullable

for non WholePoem sections, there must be a reference section for meters in order to make them updatable

rhymeLettersstring nullable

rhyme letters

plainTextstring nullable

verses text

htmlTextstring nullable

verses text as html (ganjoor.net format)

poemFormat0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 10 | 11 | 16 | 32 | 40 | 45 | 64 | 128 | 176 | 187 | 256 | 512 | 992 | 1024 | 2032 | 2048

poem format

cachedFirstCoupletIndexinteger

first couplet index

languagestring nullable

language, null means farsi

coupletsCountinteger

couplets count

oldGanjoorMetreIdinteger nullable

old metre id to see it needs refreshing related sections

oldRhymeLettersstring nullable

old rhyme letters to see it needs refreshing related sections

modifiedboolean

modified

excerptstring nullable

excerpt

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