Uzatılmış Garanti API Entegrasyonu
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)
Alan | Açıklama | Değer |
AuthTicket | Kimlik doğrulaması için kullanılacak ticket | Zorunlu |
Id | İşlem yapılmak istenen kayda ait benzersiz numara. | Fonksiyon destekliyorsa kullanılır |
Entity | İşlem yapılmak istenen nesne. | Fonksiyon destekliyorsa kullanılır |
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://customer.xyz/api/ExtendedWarrantyModules/ |
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ı |
GetCustomer JSON Request Modeli
{ "Filter":{ "CustomerNo":"020202", "CustomerName":"", "City":"", "IdentityNo":"", "PhoneNo":"", "County":"", "Email":"", "MobilePhoneNo":"", "VatBusinessPostingGroup":"", "GeneralBusinessPostingGroup":"", "IsEInvoice":"", "PostCode":"", "HomeMobilePhoneNo":"" }, "AuthTicket": "demodemodemodemodemodemo" }
GetCustomer JSON Response Modeli
{ "Results": [ { "CustomerNo": "020202", "CustomerName": "test", "CustomerLastName": "uk", "Address": " ", "City": null, "CustomerType": 1, "IdentityNo": null, "TaxAreaCode": null, "PhoneNo": null, "County": null, "Email": "suat.test@test.com", "MobilePhoneNo": "53x0000101", "VatBusinessPostingGroup": null, "GeneralBusinessPostingGroup": null, "IsEInvoice": false }, { "CustomerNo": "020202", "CustomerName": "alp test", "CustomerLastName": "alp test", "Address": " ", "City": null, "CustomerType": 1, "IdentityNo": null, "TaxAreaCode": null, "PhoneNo": null, "County": null, "Email": "suat.test@test.com", "MobilePhoneNo": "53x0000101", "VatBusinessPostingGroup": null, "GeneralBusinessPostingGroup": null, "IsEInvoice": false } ], "Entity": null, "HasResult": true, "Count": 31, "TotalCount": 0, "Id": 0, "Meta": null, "MessageList": [], "HasError": false, "HasMessage": false, "RrpTag": null }
GetLastServiceOrderByLicenseNo JSON Request Modeli
{ "Filter":{ "BranchCode":"", "UserName":"", "LicenseNo":"34LCR54" }, "AuthTicket": "demodemodemodemodemodemodemo" }
GetLastServiceOrderByLicenseNo JSON Response Modeli
{ "Results": [], "Entity": { "_No": "XszX000093", "_DocumentType": "TEKLİF", "_SellToCustomerNo": "Kxx455643", "_SellToCustomerName": "SAVAŞ Test", "_MakeCode": "Marka", "_ModelNo": null, "_Model": null, "_LicenseNo": "34LCR54", "_VIN": "000000000020202x", "_Description": null, "SellToAddress": null, "SellToAddress2": null, "SellToCity": null, "SellToCustomerName2": "SAVAŞ", "SellToHomeMobilePhoneNo": "53X 050 00 00", "SellToHomePhoneNo": "", "SellToMobilePhoneNo": "", "SellToPhoneNo": "", "SellToPostCode": null, "SellToCounty": null, "BillToCustomerNo": "KxK909090", "ServiceAdvisorNo": "D_Test", "ServiceAdvisor": null, "CreationDate": "2022-11-23T08:47:50.127", "Area": "Ctest", "RepeatRepair": false, "SalesPersonCode": null, "SalesPerson": null, "ServicePostingGroup": null, "InitialRegistration": "2019-01-01T00:00:00", "ServiceLineCustomers": [], "ServiceLines": [] }, "HasResult": true, "Count": 0, "TotalCount": 0, "Id": 0, "Meta": null, "MessageList": [], "HasError": false, "HasMessage": false, "RrpTag": null }
GetVehicleMakeList JSON Request Modeli
{ "Filter":{ "UserName":"Oto Test", "BranchCode":"100000" }, "AuthTicket": "demodemodemodemodemodemodemo" }
GetVehicleMakeList JSON Response Modeli
{ "Results": [ { "MakeCode": "Marka", "UserName": "Marka1" }, { "MakeCode": "Marka", "UserName": "Marka2" }, { "MakeCode": "Marka", "UserName": "Marka3" }, { "MakeCode": "Marka", "UserName": "Marka4" }, { "MakeCode": "Marka", "UserName": "Marka5" }, ], "Entity": null, "HasResult": true, "Count": 11, "TotalCount": 0, "Id": 0, "Meta": null, "MessageList": [], "HasError": false, "HasMessage": false, "RrpTag": null }
GetCurrentyList JSON Request Modeli
{ "Filter":{ "SourceCurrencyCode":"EUR" }, "AuthTicket": "demodemodemodemodemodemo" }
GetCurrentyList JSON Response Modeli
{ "Results": [ { "SourceCurrencyCode": "EURO", "DestinationCurrencyCode": "TÜRK LİRASI", "ForexBuying": 18.00000000000000000000, "ForexSelling": 18.20000000000000000000, "IsActive": true }, { "SourceCurrencyCode": "EURO", "DestinationCurrencyCode": "EURO", "ForexBuying": 180405.00000000000000000000, "ForexSelling": 180730.00000000000000000000, "IsActive": true }, { "SourceCurrencyCode": "EURO", "DestinationCurrencyCode": "TÜRK LİRASI", "ForexBuying": 180405.00000000000000000000, "ForexSelling": 180730.00000000000000000000, "IsActive": true }, { "SourceCurrencyCode": "EURO", "DestinationCurrencyCode": "TÜRK LİRASI", "ForexBuying": 18.18600000000000000000, "ForexSelling": 18.21870000000000000000, "IsActive": true }, { "SourceCurrencyCode": "EURO", "DestinationCurrencyCode": "TÜRK LİRASI", "ForexBuying": 18.18600000000000000000, "ForexSelling": 18.21870000000000000000, "IsActive": true } ], "Entity": null, "HasResult": true, "Count": 5, "TotalCount": 0, "Id": 0, "Meta": null, "MessageList": [], "HasError": false, "HasMessage": false, "RrpTag": null }
GetServiceInvoiceHeader JSON Request Modeli
{ "Filter":{ "VIN":"", "LicenseNo":"34LCR54", "ServiceOrderNo":"", "DocumentNo":"", "BillToCustomerNo":"" }, "AuthTicket": "demodemodemodemodemodemo" }
GetServiceInvoiceHeader JSON Response Modeli
{ "Results": [], "Entity": [ { "CancelReason": "test" } ], "HasResult": true, "Count": 0, "TotalCount": 0, "Id": 0, "Meta": null, "MessageList": [], "HasError": false, "HasMessage": false, "RrpTag": null }
SendInvoiceNoToIncedea JSON Request Modeli
{ "Filter":{ "InvoiceDate":"", "InvoiceNumber":"02020202" }, "AuthTicket": "demodemodemodemodmeodemo" }
SendInvoiceNoToIncedea JSON Response Modeli
{ "Results": [], "Entity": true, "HasResult": true, "Count": 0, "TotalCount": 0, "Id": 0, "Meta": null, "MessageList": [], "HasError": false, "HasMessage": false, "RrpTag": null }