GAganjoor
Recitation

returns paginated published recitations (if poetId or catId is non-zero its ordered by poemId ascending if not it is ordered by publish date descending)

Changed on
get/api/audio/published

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

PageNumberinteger

page number starting from 1

PageSizeinteger

settable page size (-1 == all items, 1000 maxpagesize)

searchTermstring

empty: no search term, non-empty: searches within AudioArtist, AudioTitle, poem.FullTitle and poem.PlainText simultaneously

poetIdinteger
catIdinteger

Response

OK

idinteger

Audio Id

poemIdinteger

Ganjoor Post Id

poemFullTitlestring nullable

Poem Full Title

poemFullUrlstring nullable

Poem Full Url (without domain name)

audioTitlestring nullable

Audio Title

audioArtiststring nullable

Audio Artist

audioArtistUrlstring nullable

Audio Artist Url

audioSrcstring nullable

Audio Source

audioSrcUrlstring nullable

Audio Src Url

legacyAudioGuidstring uuid

Legacy Audio Guid

mp3FileCheckSumstring nullable

Audio File CheckSum

mp3SizeInBytesinteger

mp3 size in bytes

publishDatestring date-time

Publish Date

fileLastUpdatedstring date-time

File Last Updated

mp3Urlstring nullable

Mp3 Url

xmlUrlstring nullable

Url of the synchronization (xml) file. Like Mp3Url, it points to the external assets host (ExternalAssets:RootUrl) when files are loaded from an external server, which must send CORS headers for browser scripts to read it; otherwise it is {WebServiceUrl.Url}/api/audio/file/{audio.Id}.xml

xmlTextstring nullable

Xml Text, xml file url is {WebServiceUrl.Url}/api/audio/file/{audio.Id}.xml

plainTextstring nullable

Poem Plain Text

htmlTextstring nullable

Poem Html Text

audioOrderinteger

This determines where an audio is displayed between a list of sounds related to a specfic poem

recitationType0 | 1 | 1000

recitation type

inSyncWithTextboolean

in sync with text

upVotedByUserboolean

upvoted by current user (filled at client)

Changes