Sign in
general
takhtits

List all Takhtits (text annotations/notes)

Changed on
get/takhtits/

Request

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

Query parameters

accountstring uuid
creatorstring uuid
limitinteger

Number of results to return per page.

mushaf'hafs'

Short name of the Mushaf to filter Takhtits by. Common value: 'hafs'. Any string is accepted. (e.g. 'hafs', 'warsh', etc.)

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
creatorstring uuid required
rasm_ol_mushafstring uuid required
accountstring uuid required
created_atstring date-time required

Changes

  • ac56dc5b6706Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      removed the required write-only property items/account_id from the response with the status

    • info

      removed the required write-only property items/mushaf_id from the response with the status

  • 8218b12cca18Revision changes
    • info

      added the new optional query request parameter rasm_ol_mushaf