takhtits

List all ayahs_breakers for this takhtit (ayahs map style)

Changed on

Returns a flat list containing an entry for every ayah in this takhtit, with breaker info similar to the mushaf ayah_map action.

get/takhtits/{id}/ayahs_breakers/

Request

  • The document declares no server URL.
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

A UUID string identifying this takhtit.

Query parameters

accountstring uuid
creatorstring uuid
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

ordering'asc' | 'desc'

Which field to use when ordering the results.

rasm_ol_mushafstring uuid
searchstring

A search term.

Response

idstring uuid required

id of the ayah

surahinteger required

Surah number

ayahinteger required

Ayah number

lengthinteger required

Ayah text length

juzinteger nullable required

Juz number (null if not a juz breaker)

hizbinteger nullable required

Hizb number (null if not a hizb breaker)

pageinteger nullable required

Page number (null if not a page breaker)

rubinteger nullable required

Rub number (null if not a rub breaker)

manzilinteger nullable required

Manzil number (null if not a manzil breaker)

Changes

  • 8218b12cca18Revision changes
    • warning

      deleted the query request parameter mushaf

    • info

      added the new optional query request parameter rasm_ol_mushaf