GAganjoor
Numbering

update an existing numbering (Auth policies: ganjoor:modify)

put/api/numberings

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Request body

idinteger

id

namestring nullable

name

startCatIdinteger

starting category id

endCatIdinteger nullable

ending category id

totalLinesinteger

lines count

totalVersesinteger

verse count

totalCoupletsinteger

total poem couplets

totalParagraphsinteger

total paragraphs

lastCountingDatestring date-time

last counting date

Example request

{
  "startCat": {
    "poet": {
      "rImage": {
        "folderName": "2017-08",
        "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
      }
    },
    "rImage": {
      "folderName": "2017-08",
      "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
    }
  },
  "endCat": {
    "poet": {
      "rImage": {
        "folderName": "2017-08",
        "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
      }
    },
    "rImage": {
      "folderName": "2017-08",
      "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
    }
  }
}

Response

OK

boolean required

Changes

No recorded changes to this operation across all 43 revisions of this API.