Emirates Post API

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 /GetCountryDetails/	This endpoint can be used to retrieve all Countries names, codes, Arabic names and IDs.
3.2	Get Emirates Details	GET /GetEmiratesDetails/	This endpoint can be used to retrieve all Emirates names, codes, Arabic names and IDs.
3.3	Get Zone Details	GET /GetZoneByEmiratesId?EmiratesId={EmiratesId}	This endpoint can be used to retrieve all Zones names, Arabic names and IDs.
3.4	Get Region Details	GET /GetRegionDetails?EmiratesId={EmiratesId}&ZoneId={ZoneId}	This endpoint can be used to retrieve all Regions names, Arabic names, codes and IDs.
3.5	Get Offices Details	GET /GetCounterOfficesByCourierEmirate/	This endpoint can be used to retrieve all Offices names, Arabic names, latitude, longitude and IDs.
3.6	Get Cities Details	GET /GetCitiesByCountryId?CountryId={CountryId}	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 /GetCountryDetails/

Description

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

URL: https://osbtest.epg.gov.ae/ebs/genericapi/booking/rest/GetCountryDetails

Required Headers

Content-Type: application/json

Sample Response


{
    "GetCountryDetailsResult": {
        "CountriesDeatilsBO": [
            {
                "CountryID": "247",
                "CountryNameEN": "AFGHANISTAN",
                "CountryNameAR": "افغانستان",
                "AlphaTwoDigit": "AF",
                "AlphaThreeDigit": "AFG",
                "NumericCode": "4",
                "DailingCode": "93"
            },
            {
                "CountryID": "2",
                "CountryNameEN": "ALBANIA",
                "CountryNameAR": "البانيا",
                "AlphaTwoDigit": "AL",
                "AlphaThreeDigit": "ALB",
                "NumericCode": "8",
                "DailingCode": "355"
            },
            {
                "CountryID": "3",
                "CountryNameEN": "ALGERIA",
                "CountryNameAR": "الجزائر",
                "AlphaTwoDigit": "DZ",
                "AlphaThreeDigit": "DZA",
                "NumericCode": "12",
                "DailingCode": "213"
            }
        ]
    }
}

3.2 Get Emirates Details

GET /GetEmiratesDetails/

Description

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

URL: https://osbtest.epg.gov.ae/ebs/genericapi/lookups/rest/GetEmiratesDetails

Required Headers

Content-Type: application/json

Sample Response


{
    "GetEmiratesDetailsResult": {
        "EmirateBO": [
            {
                "EmirateID": "2",
                "EmirateName": "Abu Dhabi",
                "EmirateCode": "AUH",
                "EmirateNameAr": "أبوظبي"
            },
            {
                "EmirateID": "4",
                "EmirateName": "Ajman",
                "EmirateCode": "AJM",
                "EmirateNameAr": "عجمان"
            },
            {
                "EmirateID": "12",
                "EmirateName": "Al Ain",
                "EmirateCode": "AIN",
                "EmirateNameAr": "العين"
            },
            {
                "EmirateID": "1",
                "EmirateName": "Dubai",
                "EmirateCode": "DXB",
                "EmirateNameAr": "دبي"
            },
            {
                "EmirateID": "5",
                "EmirateName": "Fujairah",
                "EmirateCode": "FUJ",
                "EmirateNameAr": "الفجيرة"
            },
            {
                "EmirateID": "6",
                "EmirateName": "Ras Al Khaimah",
                "EmirateCode": "RAK",
                "EmirateNameAr": "رأس الخيمة"
            },
            {
                "EmirateID": "3",
                "EmirateName": "Sharjah",
                "EmirateCode": "SHJ",
                "EmirateNameAr": "الشارقة"
            },
            {
                "EmirateID": "7",
                "EmirateName": "Umm Al Quwain",
                "EmirateCode": "UAQ",
                "EmirateNameAr": "أم القوين"
            }
        ]
    }
}

3.3 Get Zone Details

GET /GetZoneByEmiratesId?EmiratesId={EmiratesId}

Description

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

URL: https://osbtest.epg.gov.ae/ebs/genericapi/lookups/rest/GetZoneByEmiratesId?EmiratesId={EmiratesId}

Required Headers

Content-Type: application/json

Sample Response


{
    "GetZoneByEmiratesIdResult": {
        "ZoneBO": [
            {
                "ZoneID": "149",
                "ZoneName": "Dubai City",
                "ZoneNameAR": "منطقة دبي",
                "EmirateID": "1"
            },
            {
                "ZoneID": "115",
                "ZoneName": "Dubai Outside City",
                "ZoneNameAR": "خارج مدينة دبي",
                "EmirateID": "1"
            },
            {
                "ZoneID": "51235",
                "ZoneName": "Post Office Local",
                "ZoneNameAR": "Post Office Local",
                "EmirateID": "1"
            },
            {
                "ZoneID": "51236",
                "ZoneName": "PUDO-DXB",
                "ZoneNameAR": "PUDO-DXB",
                "EmirateID": "1"
            }
        ]
    }
}

3.4 Get Region Details

Get /GetRegionDetails?EmiratesId={EmiratesId}&ZoneId={ZoneId}

Description

This endpoint can be used to retrieve all Regions name's, Arabic name's, code's and ID's.

URL: https://osbtest.epg.gov.ae/ebs/genericapi/lookups/rest/GetRegionDetails?EmiratesId={EmiratesId}&ZoneId={ZoneId}

Required Headers

Content-Type: application/json

Sample Response


{
    "GetRegionDetailsResult": {
        "RegionBO": [
            {
                "RegionID": "182",
                "RegionName": "(Dubai Investment Park) DIP 1",
                "RegionNameAR": "مجمع دبي للاستثمار 1",
                "RegionCode": "DXB-181",
                "EmirateID": "1",
                "ZoneName": "Dubai City",
                "ZoneNameAR": "منطقة دبي",
                "ZoneID": "149"
            },
            {
                "RegionID": "183",
                "RegionName": "(Dubai Investment Park) DIP 2",
                "RegionNameAR": "مجمع دبي للاستثمار 2",
                "RegionCode": "DXB-182",
                "EmirateID": "1",
                "ZoneName": "Dubai City",
                "ZoneNameAR": "منطقة دبي",
                "ZoneID": "149"
            },
            {
                "RegionID": "4",
                "RegionName": "Abu Hail",
                "RegionNameAR": "أبو هيل",
                "RegionCode": "DXB-3",
                "EmirateID": "1",
                "ZoneName": "Dubai City",
                "ZoneNameAR": "منطقة دبي",
                "ZoneID": "149"
            }
        ]
    }
}

3.5 GET Offices Details

GET /GetCounterOfficesByCourierEmirate/

Description

This endpoint can be used to retrieve all offices names, Arabic names, latitude, longitude and IDs.

URL: https://osbtest.epg.gov.ae/ebs/epg.pos.PostalBulkMailService.rest/GetCounterOfficesByCourierEmirate

Required Headers

Content-Type: application/json

GetCounterOfficesByCourierEmirate Object

Property Name	Data Type	Mandatory	Allowed Values
emirateId	String	Yes

Sample Response


{
    "GetCounterOfficesByCourierEmirateResult": {
        "ResponseCode": "100",
        "ResponseMessage": "SUCCESS",
        "ErrorDetail": {
            "@nil": "true"
        },
        "CounterOffices": {
            "CounterOffices": [
                {
                    "OfficeId": "211",
                    "OfficeNameEng": "Al Ramool Post Office",
                    "OfficeNameArb": "مكتب بريد الرمول",
                    "Latitude": "25.23651",
                    "Longitude": "55.35804"
                },
                {
                    "OfficeId": "228",
                    "OfficeNameEng": "TECOM Post Office",
                    "OfficeNameArb": "مكتب بريد تيكوم",
                    "Latitude": "25.102597",
                    "Longitude": "55.161563"
                },
                {
                    "OfficeId": "202",
                    "OfficeNameEng": "Union Square Post Office",
                    "OfficeNameArb": "مكتب بريد ميدان الإتحاد",
                    "Latitude": "25.2666167",
                    "Longitude": "55.31135"
                }
            ]
        }
    }
}

3.6 Get Cities Details

GET /GetCitiesByCountryId?CountryId={CountryId}

Description

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

URL: https://osbtest.epg.gov.ae/ebs/genericapi/lookups/rest/GetCitiesByCountryId?CountryId={CountryId}

Sample Response


{
  "CitiesByCountryIdResponse" : {
    "Cities" : {
      "City" : [ {
        "Cityid" : "326851",
        "CityName" : "9 MILE POINT",
        "CityNameAR" : "9 MILE POINT",
        "CityCode" : "MSY"
      }, {
        "Cityid" : "403406",
        "CityName" : "AARONSBURG",
        "CityNameAR" : "AARONSBURG",
        "CityCode" : "MDT"
      }, {
        "Cityid" : "313003",
        "CityName" : "ABBEVILLE",
        "CityNameAR" : "ABBEVILLE",
        "CityCode" : "ATL"
      }, {
        "Cityid" : "381535",
        "CityName" : "ABBEVILLE",
        "CityNameAR" : "ABBEVILLE",
        "CityCode" : "MSY"
      }, {
        "Cityid" : "321052",
        "CityName" : "ABBEVILLE",
        "CityNameAR" : "ABBEVILLE",
        "CityCode" : "MEM"
      }]
    }
  }
}