Get translations for specific Rub el Hizb

Get list of translations for a specific Rub el Hizb. Alias route for the same rub el hizb filter.

Path Parameters

resource_id number required

Translation resource ID

rub_el_hizb_number number required

Possible values: >= 1 and <= 240

Query Parameters

fields string

Comma-separated list of extra translation fields to include. Supported values: chapter_id, verse_number, verse_key, juz_number, hizb_number, rub_el_hizb_number, page_number, ruku_number, manzil_number, resource_name, language_name, language_id, id.

page integer

Default value: 1

For paginating within the result

per_page integer

Possible values: >= 1 and <= 50

Default value: 10

records per api call, you can get maximum 50 records.

Responses

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

---

Successful response

application/json

Schema

Example (from schema)

Example

---

Schema

translations object[]
Array [
resource_id integer required
resource_name string
id integer
text string required
Text of the translation, text could have HTML tags for formatting and footnotes.
verse_id integer
language_id integer
language_name string
verse_key string
chapter_id integer
verse_number integer
juz_number integer
hizb_number integer
page_number integer
rub_el_hizb_number integer
ruku_number integer
manzil_number integer
foot_notes object
Map of footnote IDs to their text. Present when foot_notes=true.
property name* string
]
pagination object
per_page integer
Entries per api call
current_page integer
Current page in paginated result
next_page integer nullable
Next page in paginated result
total_pages integer
Total number of pages
total_records integer

{
  "translations": [
    {
      "resource_id": 131,
      "resource_name": "Dr. Mustafa Khattab, the Clear Quran",
      "id": 903958,
      "text": "In the Name of Allah - the Most Compassionate, Most Merciful.",
      "verse_id": 1,
      "language_id": 38,
      "language_name": "english",
      "verse_key": "1:1",
      "chapter_id": 1,
      "verse_number": 1,
      "juz_number": 1,
      "hizb_number": 1,
      "rub_el_hizb_number": 1,
      "page_number": 1,
      "ruku_number": 1,
      "manzil_number": 1,
      "foot_notes": {
        "1": "Some editions note variant readings here."
      }
    }
  ],
  "pagination": {
    "per_page": 1,
    "current_page": 1,
    "next_page": 2,
    "total_pages": 7,
    "total_records": 7
  }
}

{
  "translations": [
    {
      "id": 215201,
      "resource_id": 20,
      "text": "In the Name of Allah-the Most Compassionate, Most Merciful."
    },
    {
      "id": 215202,
      "resource_id": 20,
      "text": "All praise is for Allah, Lord of all worlds."
    }
  ],
  "pagination": {
    "per_page": 50,
    "current_page": 1,
    "next_page": 2,
    "total_pages": 12,
    "total_records": 600
  }
}

Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

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

Will be returned when the request is unauthorized.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "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)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "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)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "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)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

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

Rate-limit exceeded

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "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)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

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

Bad Gateway

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

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

Service Unavailable

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

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

Gateway Timeout

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [gateway_timeout, service_unavailable, bad_gateway, internal_server_error, unprocessable_entity, not_found, forbidden, unauthorized, invalid_request, invalid_token, insufficient_scope, service_error, invalid_path, rate_limit_exceeded]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "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...