An error occured. Details Hide
You have unsaved pages. Restore Cancel

Regions (1 dataset)

The endpoint returns list of all the regions in dataset provided by the user if the dataset is public or owned by logged-in user.
 
Input
DatasetId: Unique identifier for a dataset. 
 
Result:
 
NameTypeDescription
datasetIdstringDataset's unique identifier
geoDimensionIdstringId of geographical dimension
regionsList<RegionInfo>List of regions
keyintkey for the region
namestringname of region
regionIdstringid of the region
fieldsDictionary<string, object>Metadat fields of region member
 
Example:
Get: http://data.gov.om/api/1.0/meta/dataset/wkksqbb/regions
[
  {
    "datasetId": "OMINF2016",
    "geoDimensionId": "region",
    "regions": [
      {
        "key": 1000000,
        "name": "Oman",
        "regionId": "OM",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "1",
          "regionid": "OM",
          "iso": "OM",
          "description": ""
        }
      },
      {
        "key": 1000020,
        "name": "Muscat",
        "regionId": "OM-MA",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "103",
          "regionid": "OM-MA",
          "iso": "OM.MA",
          "description": ""
        }
      },
      {
        "key": 1000090,
        "name": "Dhofar",
        "regionId": "OM-ZU",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "106",
          "regionid": "OM-ZU",
          "iso": "OM.JA",
          "description": ""
        }
      },
      {
        "key": 1000200,
        "name": "Musandam",
        "regionId": "OM-MU",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "101",
          "regionid": "OM-MU",
          "iso": "OM.MU",
          "description": ""
        }
      },
      {
        "key": 1000250,
        "name": "Al Buraymi",
        "regionId": "OM-BU",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "13403425",
          "regionid": "OM-BU",
          "iso": "OM.BU",
          "description": ""
        }
      },
      {
        "key": 1000290,
        "name": "Ad Dakhliyah",
        "regionId": "OM-DA",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "104",
          "regionid": "OM-DA",
          "iso": "OM.DA",
          "description": ""
        }
      },
      {
        "key": 1000390,
        "name": "Al Batinah",
        "regionId": "OM-BA",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "17122153",
          "regionid": "OM-BA",
          "iso": "OM-BA",
          "description": ""
        }
      },
      {
        "key": 1000400,
        "name": "Al Batinah North",
        "regionId": "OM-BA-NO",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "13403525",
          "regionid": "OM-BA-NO",
          "iso": "OM.BN",
          "description": ""
        }
      },
      {
        "key": 1000470,
        "name": "Al Batinah South",
        "regionId": "OM-BA-SO",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "13467625",
          "regionid": "OM-BA-SO",
          "iso": "OM.BS",
          "description": ""
        }
      },
      {
        "key": 1000540,
        "name": "Ash Sharqiyah",
        "regionId": "OM-SH",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "17122273",
          "regionid": "OM-SH",
          "iso": "OM-SH",
          "description": ""
        }
      },
      {
        "key": 1000550,
        "name": "Ash Sharqiyah South",
        "regionId": "OM-SH-SO",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "13048925",
          "regionid": "OM-SH-SO",
          "iso": "OM.SS",
          "description": ""
        }
      },
      {
        "key": 1000610,
        "name": "Ash Sharqiyah North",
        "regionId": "OM-SH-NO",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "13469025",
          "regionid": "OM-SH-NO",
          "iso": "OM.SN",
          "description": ""
        }
      },
      {
        "key": 1000680,
        "name": "Adh Dhahirah",
        "regionId": "OM-ZA",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "105",
          "regionid": "OM-ZA",
          "iso": "OM.DH",
          "description": ""
        }
      },
      {
        "key": 1000720,
        "name": "Al Wusta",
        "regionId": "OM-WU",
        "isRealRegion": true,
        "level": 0,
        "fields": {
          "id": "102",
          "regionid": "OM-WU",
          "iso": "OM.WU",
          "description": ""
        }
      }
    ]
  }
]