İl ve İlçe Listeleme - listCounties()

İl ve İlçe Listeleme

Horoz tarafında tanımlı olan dağıtım operasyonunda kullanılan İç İşleri Bakanlığı’na ait Türkiye’de tanımlanan il-ilçe tanımlarının listesi ve ihracat yapılan ülkelerin ülke ve şehir bilgileri bu metot içinden liste olarak alınabilir.
Ülke, şehir ve ilçe seçimlerinin formlara eklenmesi durumunda bu listedeki bilgiler kullanılabilir. Oluşturulacak kayıtlarda ülke şehir ve ilçe alanlarındaki değerleri bu listede yer alanlardan farklı olmaması beklenir. Aksi durumda kayıt başarısız olarak hata uyarısı alır. listCounties() metodu, Horoz sistemine tanımlanmış ülke şehir ve ilçe listesini istemciye dönen fonksiyondur. E-İhracat entegrasyon web servisi içerisinde bulunan listCounties() metodu, parametre olarak processKey bilgisini header üzerinden, countryName, cityName ve countyName bilgilerini body üzerinden POST olarak alır. İlgili metot istemciye yanıt olarak countryName, cityName, countyName bilgilerini döner.

---

POST listCounties()

ENDPOINT

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

Parametre Açıklamaları & Kuralları

Aşağıdaki tabloda listCounties() işleminin giriş ve çıkış parametreleri ve bu parametrelerin tür ve formatları listelenmiştir.

Alanlar

Parametre	Açıklama	Veri Tipi	Uzunluk	Alan Yeri	Zorunluluk
processKey	İstemci için tanımlanan processKey bilgisi	string	100	Header	Zorunlu
countryName	Ülke adı	string	100	inBody Request	Opsiyonel
cityName	Şehir adı	string	100	inBody Request	Opsiyonel
countyName	İlçe adı	string	100	inBody Request	Opsiyonel

Örnek İstek

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

Örnek Cevap

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

---

Servis Cevapları

Servise ait başarılı/başarısız servis cevaplarına buradan erişebilirsiniz.