Sign in
OpenAPI 3.0.42026-08-14481162870.6 KB

64a5b49a158a

Ganjoor

suggest new quote (for normal users) (Auth)

post/api/ganjoor/quoted/suggest

Request body

idstring uuid

record id

poemIdinteger

poem id

relatedPoemIdinteger nullable

related poem id (this could be a poem we do not have it available)

isPriorToRelatedboolean

this poem is written and should be displayed prior to the related poem

chosenForMainListboolean

if the related poet poem has multiple poems related to this poem, which one is chosen to be shown at main poems pages?

sortOrderinteger

this sort order can be used to pin a record on top

cachedRelatedPoemPoetDeathYearInLHijriinteger

related poem peot death date in hijri (used for sorting)

cachedRelatedPoemPoetNamestring nullable

related poem poet name

cachedRelatedPoemPoetUrlstring nullable

related poem poet url

cachedRelatedPoemPoetImagestring nullable

related poem poet image

cachedRelatedPoemFullTitlestring nullable

full title

cachedRelatedPoemFullUrlstring nullable

full url

coupletVerse1string nullable

couplet 1 verse 1

coupletVerse1ShouldBeEmphasizedboolean

is main part

coupletVerse2string nullable

couplet 1 verse 2

coupletVerse2ShouldBeEmphasizedboolean

is main part

coupletIndexinteger nullable

couplet 1 index

relatedCoupletVerse1string nullable

related couplet 1 verse 1

relatedCoupletVerse1ShouldBeEmphasizedboolean

is main part

relatedCoupletVerse2string nullable

related couplet 1 verse 2

relatedCoupletVerse2ShouldBeEmphasizedboolean

is main part

relatedCoupletIndexinteger nullable

related couplet 1 index

notestring nullable

description

publishedboolean

published (approved)

samePoemsQuotedCountinteger

when a poem contains more than one quoted couplet from another one this should be more than 1

claimedByBothPoetsboolean

poems (same poem) are claimed by both poets

poetIdinteger

poet id (redundant for simplifying queries)

relatedPoetIdinteger nullable

related poet id

indirectQuotationboolean

related indirectly

rejectedboolean

approved

reviewNotestring nullable

review note

suggestedByIdstring uuid nullable

suggested by

Example request

{
  "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            "
    }
  }
}

Response

OK

idstring uuid

record id

poemIdinteger

poem id

relatedPoemIdinteger nullable

related poem id (this could be a poem we do not have it available)

isPriorToRelatedboolean

this poem is written and should be displayed prior to the related poem

chosenForMainListboolean

if the related poet poem has multiple poems related to this poem, which one is chosen to be shown at main poems pages?

sortOrderinteger

this sort order can be used to pin a record on top

cachedRelatedPoemPoetDeathYearInLHijriinteger

related poem peot death date in hijri (used for sorting)

cachedRelatedPoemPoetNamestring nullable

related poem poet name

cachedRelatedPoemPoetUrlstring nullable

related poem poet url

cachedRelatedPoemPoetImagestring nullable

related poem poet image

cachedRelatedPoemFullTitlestring nullable

full title

cachedRelatedPoemFullUrlstring nullable

full url

coupletVerse1string nullable

couplet 1 verse 1

coupletVerse1ShouldBeEmphasizedboolean

is main part

coupletVerse2string nullable

couplet 1 verse 2

coupletVerse2ShouldBeEmphasizedboolean

is main part

coupletIndexinteger nullable

couplet 1 index

relatedCoupletVerse1string nullable

related couplet 1 verse 1

relatedCoupletVerse1ShouldBeEmphasizedboolean

is main part

relatedCoupletVerse2string nullable

related couplet 1 verse 2

relatedCoupletVerse2ShouldBeEmphasizedboolean

is main part

relatedCoupletIndexinteger nullable

related couplet 1 index

notestring nullable

description

publishedboolean

published (approved)

samePoemsQuotedCountinteger

when a poem contains more than one quoted couplet from another one this should be more than 1

claimedByBothPoetsboolean

poems (same poem) are claimed by both poets

poetIdinteger

poet id (redundant for simplifying queries)

relatedPoetIdinteger nullable

related poet id

indirectQuotationboolean

related indirectly

rejectedboolean

approved

reviewNotestring nullable

review note

suggestedByIdstring uuid nullable

suggested by

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            "
    }
  }
}