City and District List- listCounties()

City and District List

The list of city-district definitions, which are used in the distribution operation defined by Horoz, and which are defined in Türkiye by the Ministry of Internal Affairs, and the country and city information about the countries, to which export is performed, may be obtained as a list from this method. The information available in this list may be used in the event that the country, city and district selections are added to the forms. The values available in the country, city and district fields are expected to be no different from those, which are provided in this list, regarding the records to be created. Otherwise, the record will fail and receive an error warning. The listCounties() method is the function that returns the list of countries, cities and counties, which is defined into the Horoz system, to the client. The listCounties() method available in the E-Export integration web service receives the processKey information as a parameter through the header, while it receives the countryName, cityName and countyName information as a POST through the body. The relevant method returns the countryName, cityName, countyName information as a response to the client.

---

POST listCounties()

ENDPOINT

http://b2btest.horoz.com.tr:7801/eexport_test/v1/listCounties

Parameter Descriptions & Rules

The following table shows the input and output parameters of the listCounties() operation and their The types and formats of the parameters are listed.

Fields

PARAMETER	DESCRIPTION	DATA TYPE	LENGTH	FIELD LOCATION	REQUIRMENT
processKey	processKey information defined for the client	string	100	Header	Mandatory
countryName	Country name	string	100	inBody Request	Optional
cityName	City name	string	100	inBody Request	Optional
countyName	County name	string	100	inBody Request	Optional

Example Request

{
  "countryName": null,
  "cityName": null,
  "countyName":""
}

Example Response

{
  "listCountiesResponse": {
    "responseCode": "STA-100",
    "responseMessage": "ISLEM BASARILI",
    "listCounties": {
      "county": [
        {
          "countryName": "ANDORA",
          "cityName": "CANILLO",
          "countyName": null
        }
      ]
    }
  }
}

---

Service Responses

You can access the successful/unsuccessful service responses here.