Get user preferences

Get all user preferences like theme, favorite reciter, default language etc.

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object

theme object

type string

Possible values: [auto, light, sepia, dark]

reading object

readingPreference string required

Possible values: [translation, reading]

selectedWordByWordLocale string required

Possible values: [en, ur, id, bn, tr, fa, ru, hi, de, ta, inh, fr]

wordClickFunctionality string required

Possible values: [play-audio, no-audio]

isReadingByRevelationOrder boolean

wordByWordContentType string[] required

Possible values: [translation, transliteration]

wordByWordDisplay string[] required

Possible values: [tooltip, inline]

quranReaderStyles object

tafsirFontScale integer required

Possible values: >= 1 and <= 10

quranTextFontScale integer required

Possible values: >= 1 and <= 10

translationFontScale integer required

Possible values: >= 1 and <= 10

wordByWordFontScale integer required

Possible values: >= 1 and <= 6

quranFont string

Possible values: [code_v1, code_v2, text_uthmani, text_indopak, qpc_uthmani_hafs, tajweed, tajweed_v4]

mushafLines string

Possible values: [15_lines, 16_lines]

translations object

selectedTranslations integer[]

tafsirs object

selectedTafsirs string[]

audio object

reciter integer required

playbackRate integer

Possible values: [0.25, 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2]

showTooltipWhenPlayingAudio boolean

enableAutoScrolling boolean

language object

language string

Possible values: [en, ar, bn, fa, fr, id, it, nl, pt, ru, sq, th, tr, ur, zh, ms, es, sw]

{
  "success": true,
  "data": {
    "theme": {
      "type": "auto"
    },
    "reading": {
      "readingPreference": "translation",
      "selectedWordByWordLocale": "en",
      "wordClickFunctionality": "play-audio",
      "isReadingByRevelationOrder": true,
      "wordByWordContentType": [
        "translation"
      ],
      "wordByWordDisplay": [
        "tooltip"
      ]
    },
    "quranReaderStyles": {
      "tafsirFontScale": 3,
      "quranTextFontScale": 3,
      "translationFontScale": 3,
      "wordByWordFontScale": 3,
      "quranFont": "code_v1",
      "mushafLines": "16_lines"
    },
    "translations": {
      "selectedTranslations": [
        131
      ]
    },
    "tafsirs": {
      "selectedTafsirs": [
        "en-tafisr-ibn-kathir"
      ]
    },
    "audio": {
      "reciter": 7,
      "playbackRate": 1,
      "showTooltipWhenPlayingAudio": true,
      "enableAutoScrolling": true
    },
    "language": {
      "language": "en"
    }
  }
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

Loading...