Website Entegrasyonu GetDistricts API
Licrus modülleriyle entegrasyon ve senkronizasyon sağlamak için bu dokümanda yer alan servisler kullanılır. Servisler JSON Web Servisleri olarak geliştirilmiştir.İle bağlı olan ilçeleri almak için ise aşağıda servis kullanılır.
Servis Nesneleri
Servis üzerinden yayınlanan tüm metotlar, Request nesnesi alır ve Response nesnesi döner. Request ve Response nesneleri kullanıldığı metoda özgü alanlar içermekle birlikte ortak bazı alanlar da içerirler;
Request (İstek)
| Alan | Açıklama | Değer |
| AuthTicket | Kimlik doğrulaması için kullanılacak ticket | Zorunlu |
| CityId | İlçeleri almak için | Zorunlu |
Response (Cevap)
| Alan | Açıklama |
| HasError | İşlem sonucunda bir hata oluştuysa true değer döner. Yapılan işlem başarılıysa false değer alır. |
| HasMessage | İşlem sonucunda paylaşılan bir bilgi mesajı varsa true değer verir. |
| MessageList | HasError veya HasMessage alanlarından herhangi bir true ise hata veya bilgi mesajı buradan alınabilir. |
Response (Cevap)
Response.MessageList
Mesaj nesnesini barındıran listedir ve içerisinde yer alan Message nesnesinin detayları aşağıdaki gibidir.
| Alan | Açıklama |
| Message | Hata veya Bilgi mesajı metin olarak buradan alınabilir. |
| Url | https://websitename.xyz/external/WebSite/GetDistricts |
| Type | Servis tarafından gönderilen mesajın tipini verir. ServiceResponseMessageType tipinde bir enum değeri taşır. Bu alan 3 tip değer alabilir, bunlar; Error: Hata Info: Bilgi Warning: Uyarı |
GetDistricts JSON Request Modeli
Sistem üzerinden ilçeleri almak için
{
"AuthTicket": "demodemodemodemodemodemo",
"CityId":34
}
GetDistricts JSON Response Modeli
{
"Results": [
{
"Id": 441,
"Name": "ADALAR"
},
{
"Id": 442,
"Name": "ARNAVUTKOY"
},
{
"Id": 443,
"Name": "ATASEHIR"
},
{
"Id": 444,
"Name": "AVCILAR"
},
{
"Id": 480,
"Name": "USKUDAR"
},
{
"Id": 481,
"Name": "ZEYTINBURNU"
}
],
"MessageList": [],
"HasError": false,
"HasMessage": false
}