Website Entegrasyonu GetCities 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

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)

AlanAçıklama
Değer
AuthTicketKimlik doğrulaması için kullanılacak ticketZorunlu

Response (Cevap)

AlanAçı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.
MessageListHasError 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.

AlanAçıklama
MessageHata veya Bilgi mesajı metin olarak buradan alınabilir.
Urlhttps://websitename.xyz/external/WebSite/GetCities
TypeServis 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ı

GetCities JSON Request Modeli
Sistem üzerinden ilçeleri almak için

{
	"AuthTicket": "demodemodemodemodemodemo",
	
}


GetCities  JSON  Response Modeli

{
	"Results": [
		{
			"Id": 1,
			"Name": "ADANA"
		},
		{
			"Id": 2,
			"Name": "ADIYAMAN"
		},
		{
			"Id": 80,
			"Name": "OSMANIYE"
		},

		{
			"Id": 81,
			"Name": "DUZCE"
		},
		{
			"Id": 82,
			"Name": "BILINMEYEN"
		}
	],
	"MessageList": [],
	"HasError": false,
	"HasMessage": false
}