khda_private_schools_erc-open-api
Updated: 19 Sep 2021 0.00 KB
API
All data related to active (operational) private schools in Dubai that includes curriculm, school ratings, students total enrollment and capacity per academic years.

Description:

Additional Info

Field Value
Last updated 19 Sep 2021
Created 21 May 2018
Format API
License License not specified
id
94940eca-8cf1-4777-bebc-5184e257148a
package id
c7f8bdd7-6112-47b7-896f-581e9d0a5809
revision id
f40b28b5-291c-4db7-ae58-8038e3493b16
state
active

Attribute Details

Attribute Name Attribute Description Attribute Language Attribute Classification Attribute Datatype Attribute Size Attribute Range of Values Attribute Foreign Key
name_eng The name of the Private School in English English Open string 300
educationcenterid The Education Center ID. In this dataset it is the Private school ID. English Open string 10
academic_year The academic year for school inspection English Open string 10
curriculumen The school curriculum in English English Open string 100
grades_years The available School Grades English Open string 100
students Number of Students in Academic year English Open int
school_rating School Inspection Rating per academic year English Open string 200
current_capacity School Capacity in latest academic year English Open string 10
location The school location in English (AREA) English Open string 100
school_type The school type (Profit, non-profit, charity,…). English Open string 100

There are no views created for this resource yet.

Embed resource view

You can copy and paste the embed code into a CMS or blog software that supports raw HTML

Dubai Pulse Data API

Access resource data via a web API with powerful query support.

Expand All
The Data API can be accessed via the following actions of the CKAN action API.
  • Query
    https://api.dubaipulse.gov.ae/open/khda/khda_private_schools_erc-open-api
  • End Users will receive "API Key" and "API Secret" in two separate emails on the first time Grant of a Dataset, first Purchase of a Commercial Dataset, or Purchase of an API Package. This API Key and API Secret combination should be used to generate API token and the token will need to be included in the http headers of every API call made.

    Authentication Service to generate API token: https://api.dubaipulse.gov.ae/oauth/client_credential/accesstoken?grant_type=client_credentials with body 'client_id={API Key}&client_secret={API Secret}'

    Read the value of "access_token" from the response of the above service and use it in the header of every API call. The obtained API token is valid for certain duration (for example 30 minutes) after which a fresh token needs to be obtained.

    Header Name : Authorization
    Value : Bearer {access_token}

  • Query Parameters
    API calls can be made for full dataset result (subject to maximum results limit) or to a subset of results. Different filters can be applied on the results. Developers can use the attributes to apply a combination of filters with and/or conditions.
  • Limiting the Response Size
    Developers can limit the number of records returned by an API call passing the "Limit" parameter in the call. The value of the "Limit" must be less than the allowed maximum limit.
  • Limiting the Attributes
    Developers can limit the API response to specific set of attributes by passing the attribute names in the API call. The example below explains how the attributes can be specified in the API call. This feature can be used in conjunction with query parameters.
  • Curl Command Sample:
    curl -X GET --header "Authorization: qMtn6xQapeouAlirfHXD7DWJFabV" "https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api"
  • Query Samples:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?filter=location_id=223 AND zone_id=2 https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?filter=location_id=223 OR zone_id=2
  • Record Limit Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?limit=10
  • Record Offset Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?offset=10
  • Record Order By Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?order_by=location_id
  • Attribute Limiting Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?filter=location_id=223 OR zone_id=2 &column=zone_id,line_name,location_id