Website Entegrasyonu Service 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
CityIdİle göre getirilen servisler
Zorunlu
DistrictId İlçeye göre getirilen servislerFonksiyon destekliyorsa kullanılır
ProductGroupIdÜrün grubuna göre servisler
Fonksiyon destekliyorsa kullanılır

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/GetServices
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ı

GetServices JSON Request Modeli

Kullanım -1
İle bağlı hizmet veren servisler

{
	"AuthTicket": "demodemodemodemodemodemo",
	"CityId": 34
}

Kullanım -2
İl ve ilçeye bağlı hizmet veren servisler

{
	"AuthTicket": "demodemodemodemodemodemo",
	"CityId": 34,
	"DistrictId":475
}

Kullanım -3
İl,ilçe ve ürün grubuna göre  hizmet veren servisler

{
	"AuthTicket": "demodemodemodemodemodemo",
	"CityId": 34,
	"DistrictId":475,
	"ProductGroupId":232
}


GetServices  JSON  Response Modeli

{
	"Results": [
		{
			"Title": "İRFAN AKINTI",
			"AddressLine": "KAVAKPINAR MAH. GÜZEL SK. NO 10A, ISTANBUL / SISLI",
			"MobilePhone": "1111111111",
			"WorkPhone": null,
			"ServiceExpertness": [
				"GÜNEŞ ENERJİSİ SİSTEMLERİ",
				"HAVALANDIRMA EKIPMANLARI",
				"HAVLUPANLAR",
				"ISITMA TESISATI EKIPMANLARI",
				"KLİMALAR",
				"KURUMSAL HİZMETLER",
				"TEMİZ SU TESİSATI EKİPMANLARI"
			]
		},
		{
			"Title": "ONUR TURGUT",
			"AddressLine": "ÇAMÇEŞME MAH.KEMAL PAŞA CAD GAMZADE SOK N:6, ISTANBUL / SISLI",
			"MobilePhone": "1111111111",
			"WorkPhone": "1111111111",
			"ServiceExpertness": [
				"AKSESUARLAR",
				"EV CİHAZLARI",
				"HAVLUPANLAR",
				"KLİMALAR",
				"KOMBİLER",
				"NÖBET",
				"PANEL RADYATÖRLER"
			]
		}
	],
	"MessageList": [],
	"HasError": false,
	"HasMessage": false
}