GAganjoor
Ganjoor

get correction by id (Auth policies: ganjoor:modify)

Changed on
get/api/ganjoor/correction/{id}

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

Path parameters

idinteger required

Response

OK

idinteger

Correction Id

poemIdinteger

poem Id

literaryAnnotationCompletedboolean nullable

null: no opinion; true/false: the contributor marks the literary annotation complete / not complete

titlestring nullable

title

originalTitlestring nullable

original title

rhythmstring nullable

rhythm

originalRhythmstring nullable

original rhythm

notestring nullable

note

datestring date-time

date

userIdstring uuid

user Id

userNicknamestring nullable

nickname

reviewedboolean

reviewed

reviewDatestring date-time

reviewdate

reviewNotestring nullable

review note

result0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

rhythmResult0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

rhythm2string nullable

rhythm 2

originalRhythm2string nullable

original rhythm 2

rhythm2Result0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

rhythm3string nullable

rhythm 3

originalRhythm3string nullable

original rhythm 3

rhythm3Result0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

rhythm4string nullable

rhythm 4

originalRhythm4string nullable

original rhythm 4

rhythm4Result0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

rhymeLettersstring nullable

rhyme letters

originalRhymeLettersstring nullable

original rhyme letters

rhymeLettersReviewResult0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

languagestring nullable

language

originalLanguagestring nullable

original language

languageReviewResult0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

poemSummarystring nullable

suggested poem summary

originalPoemSummarystring nullable

original poem summary

summaryReviewResult0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

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

originalPoemFormat0 | 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

poemFormatReviewResult0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

correction review result

hideMyNameboolean

hide the editors name

Changes

  • 493e82d8a523Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 330e7bb195c1Revision changes
    • info

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