Locations - Endpoints

The following table lists down the available endpoints that you can integrate with for our locations APIs.

# EndpointName Endpoint Description
3.1 Get Country Details GET /Countries This endpoint can be used to retrieve all Countries names, codes, Arabic names and IDs.
3.2 Get Emirates Details GET /Emirates/ This endpoint can be used to retrieve all Emirates names, codes, Arabic names and IDs.
3.3 Get Cities Details GET /Cities This endpoint can be used to retrieve all City names, Arabic names and IDs.

Endpoints Details

This section details each endpoint, how to make a call to it, how the request object looks, the required headers, and provides sample calls that will help you understand how to integrate with it.

3.1 Get Country Details

GET /Countries/

Description

This endpoint can be used to retrieve all Countries names, codes, Arabic names and IDs.

URL: https://masters-stg.epservices.ae/locations/api/Countries

Required Headers
  • Content-Type: application/json
Sample Response

"list": [
    {
      "id": 0,
      "code": "AFG",
      "nameEn": "AFGHANISTAN",
      "nameAr": "افغانستان",
      "abbr": null,
      "isGCC": false,
      "alphaThreeCode": "AFG",
      "alphaTwoCode": "AF"
    },
    {
      "id": 0,
      "code": "ALB",
      "nameEn": "ALBANIA",
      "nameAr": "البانيا",
      "abbr": null,
      "isGCC": false,
      "alphaThreeCode": "ALB",
      "alphaTwoCode": "AL"
    }
      ]
                                

3.2 Get Emirates Details

GET /Emirates

Description

This endpoint can be used to retrieve all emirates names, codes, Arabic names and IDs.

URL: https://masters-stg.epservices.ae/locations/api/Emirates

Required Headers
  • Content-Type: application/json
Sample Response

{
  "errorMessages": null,
  "warningMessages": null,
  "infomationMessages": null,
  "data": {
    "list": [
      {
        "id": 1,
        "nameEn": "Dubai",
        "nameAr": "دبي",
        "code": "DXB",
        "landLine": "04",
        "defaultOfficeId": "200",
        "cityAsEmirate": false
      },
      {
        "id": 2,
        "nameEn": "Abu Dhabi",
        "nameAr": "أبوظبي",
        "code": "AUH",
        "landLine": "02",
        "defaultOfficeId": "101",
        "cityAsEmirate": false
      },
      {
        "id": 3,
        "nameEn": "Sharjah",
        "nameAr": "الشارقة",
        "code": "SHJ",
        "landLine": "06",
        "defaultOfficeId": "301",
        "cityAsEmirate": false
      },
      {
        "id": 4,
        "nameEn": "Ajman",
        "nameAr": "عجمان",
        "code": "AJM",
        "landLine": "06",
        "defaultOfficeId": "401",
        "cityAsEmirate": false
      },
      {
        "id": 5,
        "nameEn": "Fujairah",
        "nameAr": "الفجيرة",
        "code": "FUJ",
        "landLine": "09",
        "defaultOfficeId": "701",
        "cityAsEmirate": false
      },
      {
        "id": 6,
        "nameEn": "Ras Al Khaimah",
        "nameAr": "رأس الخيمة",
        "code": "RAK",
        "landLine": "07",
        "defaultOfficeId": "601",
        "cityAsEmirate": false
      },
      {
        "id": 7,
        "nameEn": "Umm Al Quwain",
        "nameAr": "أم القوين",
        "code": "UAQ",
        "landLine": "06",
        "defaultOfficeId": "501",
        "cityAsEmirate": false
      }
    ],
    "count": 7
  }
}
 

3.3 Get Cities Details

GET /Cities

Description

This endpoint can be used to retrieve all City names, Arabic names and IDs.

URL: https://masters-stg.epservices.ae/locations/api/Cities?CountryIsoCode=BH

Sample Response

{
  "list": [
    {
      "nameEn": "ADLIYA",
      "nameAr": "ADLIYA",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "BUDAIYA",
      "nameAr": "BUDAIYA",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "ISA TOWN",
      "nameAr": "ISA TOWN",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "MANAMA",
      "nameAr": "MANAMA",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "MUHARRAQ",
      "nameAr": "MUHARRAQ",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "RIFFA",
      "nameAr": "RIFFA",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "SEEF",
      "nameAr": "SEEF",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "SITRA",
      "nameAr": "SITRA",
      "abbr": null,
      "code": "BAH"
    },
    {
      "nameEn": "ZALAQ",
      "nameAr": "ZALAQ",
      "abbr": null,
      "code": "BAH"
    }
  ],
  "count": 9
}