Sign in

v1

OpenAPI 3.0.42026-07-14475158859.0 KB
Recitation

Gets audio narrations, user must have recitation::moderate permission to be able to see all users narrations (Auth)

additional headers: paging-headers, audio-upload-enabled

get/api/audio

Query parameters

PageNumberinteger

page number starting from 1

PageSizeinteger

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

allUsersboolean

default: false, user must have recitation::moderate permission to be able to see all users narrations

status0 | 1 | 2 | 3 | 4 | -1

Audio Review Status

default: -1, unfiltered

searchTermstring
mistakesboolean
recitationType0 | 1 | 1000

recitation type

Response

OK

idinteger

Id

ganjoorAudioIdinteger

Final data is actually exported to a MySQL database which this auto increment field is its key

ganjoorPostIdinteger

Ganjoor Post Id

poemFullTitlestring nullable

Poem Full Title

poemFullUrlstring nullable

Poem Full Url (without domain name)

audioOrderinteger

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

fileNameWithoutExtensionstring nullable

Using this field content you would determine xml, mp3 and ogg file names

soundFilesFolderstring nullable

combining this with RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.FileNameWithoutExtension + .ext would preduce relative path of sound files on our file server the full path would become [HOMEPath] + '/i/' + this value

remoteMp3FilePathstring nullable

MP3 File Path

mp3Urlstring nullable

MP3 url

remoteOggFilePathstring nullable

OGG File Path

oggUrlstring nullable

OGG url

remoteXMLFilePathstring nullable

This is also a legacy field

xmlUrlstring nullable

XML url

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

oggSizeInBytesinteger

ogg size in bytes

uploadDatestring date-time

Upload Date

fileLastUpdatedstring date-time

File Last Updated

reviewDatestring date-time

Review Date (Approve or Reject)

localMp3FilePathstring nullable

MP3 File local path on Windows Server (if item is not rejected probably it is not valid and it is deleted)

localXmlFilePathstring nullable

XML File local path on Windows Server (if item is not rejected probably it is not valid and it is deleted)

audioSyncStatus0 | 1 | 2 | 4 | 16

Audio Synchronization Status (binary combination is acceptable)

reviewStatus0 | 1 | 2 | 3 | 4 | -1

Audio Review Status

reviewMsgstring nullable

Review Message

recitationType0 | 1 | 1000

recitation type

inSyncWithTextboolean

in sync with text

Example response

[
  {
    "owner": {
      "username": "test",
      "email": "email@domain.com",
      "phoneNumber": "+989121234567",
      "firstName": "Hamid Reza",
      "surName": "Mohammadi"
    }
  }
]