Zaman Programı Günceleme
Servis Adresi
/DealerSale/UpdateSchedule
İstek Parametreleri
DealerSaleAuthentication
Parametre | Açıklama |
---|---|
DealerCode(string) | Moka sistemi tarafından verilen bayi kodu |
Username (string) | Moka sistemi tarafından verilen Api kullanıcı adı |
Password (string) | Moka sistemi tarafından verilen Api şifresi |
CheckKey (string) | Kontrol anahtarı (DealerCode + "MK" + Username + "PD" + Password) String olarak birleştirilen bu bilgilerin SHA-256 hash algoritmasından geçirilmesiyle oluşturulur. Buraya tıklayarak deneme ekranına gidebilirsiniz. |
DealerSaleRequest
Parametre | Açıklama |
---|---|
DealerSaleScheduleId (integer) | Zaman programı eklendiğinde Moka’ dan dönen ID. Bu zaman programı güncellenecek. |
ScheduleName (string) | Zaman programının adı (örn: "Ayda bir yapılan ödeme") (Max 100), Zorunlu değil, gönderilmezse güncellenmez |
DailyWeeklyMonthly (integer) | Zorunlu değil, gönderilmezse güncellenmez. 1: Günlük çekim 2: Haftalık çekim 3: Aylık çekim |
EveryX (integer) | Zorunlu değil, gönderilmezse güncellenmez. Kaç günde, haftada veya ayda bir ödeme yapılacak (değeri 1 ise her gün, hafta veya ay anlamına gelir, değeri 2 ise, 2 günde bir, 2 haftada bir veya 2 ayda bir anlamına gelir). |
DaysOfWeek (string) | Zorunlu değil, gönderilmezse güncellenmez (DailyWeeklyMonthly = 2 gönderilirse bu alanın gönderilmesi de zorunlu)
(1: Pazartesi, 2: Salı ....... 7: Pazar, haftanın günleri virgül ile ayrılarak verilebilir. örn: 1,3 pazartesi ve çarşamba günleri) |
DaysOfMonth (string) | Zorunlu değil, gönderilmezse güncellenmez (DailyWeeklyMonthly = 3 gönderilirse bu alanın gönderilmesi de zorunlu)
(ayın günleri virgül ile ayrılarak verilebilir. örn: 1,15 yani ayın 1. ve 15. günü çekim yapılacak) |
Örnek İstek (JSON)
{
"DealerSaleAuthentication": {
"DealerCode": "xxx",
"Username": "xxx",
"Password": "xxx",
"CheckKey": "aabbccddeeff"
},
"DealerSaleRequest": {
"ScheduleName": "newschedule",
"DailyWeeklyMonthly": "3",
"EveryX": "1",
"DaysOfWeek": "",
"DaysOfMonth": "15"
}
}
Başarılı İstek Sonucu
Gönderilen istek verileri Moka’ da başarılı bir şekilde işlenmişse, geri dönüş nesnesinin "ResultCode" alanında "Success" bilgisi yazar.
"Data" alanında ise dönen işlem sonucu bulunur. "Data" içinde yer alan bilgileri kontrol ederek akışlarınızı devam ettirebilirsiniz.
Parametre | Açıklama |
---|---|
DealerSaleScheduleId (integer) | Moka tarafında, zaman programının Unique ID sidir. |
ScheduleName (string) | Zaman programının adı (örn: "Ayda bir yapılan ödeme") (Max 100) |
DailyWeeklyMonthly (integer) | 1: Günlük çekim 2: Haftalık çekim 3: Aylık çekim |
EveryX (integer) | Kaç günde, haftada veya ayda bir ödeme yapılacak (değeri 1 ise her gün, hafta veya ay anlamına gelir, değeri 2 ise, 2 günde bir, 2 haftada bir veya 2 ayda bir anlamına gelir). |
DaysOfWeek (string) | Haftanın hangi günleri çekim yapılacak. 1: Pazartesi 7: Pazar. Birden fazla gün çekim yapılacaksa virgül ile ayrılmış olarak yazar. |
DaysOfMonth (string) | Ayın hangi günleri çekim yapılacak. Birden fazla gün çekim yapılacaksa virgül ile ayrılmış olarak yazar. |
Başarılı Sonuç Örneği
{
"Data": {
"DealerSaleScheduleId": 1005,
"ScheduleName": "newschedule",
"DailyWeeklyMonthly": 2,
"EveryX": 1,
"DaysOfWeek": "1,2,3",
"DaysOfMonth": ""
},
"ResultCode": "Success",
"ResultMessage": "",
"Exception": null
}
Başarısız İstek Sonucu
Gönderilen istek verileri Moka akışları içerisinde işlenemediyse, geri dönüş nesnesinin "ResultCode" alanında alttaki tablodaki hata kodlarından birisi bulunur.
Beklenmeyen yazılımsal bir hata oluştuğunda ise, "ResultCode" alanında EX yazar ve "ResultMessage" alanında alınan hata mesajı (Exception) yer alır.
Her iki durumda da, "Data" nesnesi null olarak gelir.
ResultCode | Açıklama |
---|---|
DealerSale.UpdateSchedule.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
DealerSale.UpdateSchedule.DealerSaleScheduleIdIsRequired | Bayi satış zaman programı id gerekli. |
DealerSale.UpdateSchedule.ScheduleNotFound | Zaman programı bulunamadı. |
DealerSale.UpdateSchedule.DaysOfWeekIsRequired | Haftanın hangi günleri çekim yapılacağı bilgisi gerekli. |
DealerSale.UpdateSchedule.DaysOfMonthIsRequired | Ayın hangi günleri çekim yapılacağı bilgisi gerekli. |
DealerSale.UpdateSchedule.DaysOfWeekFormatError | Haftanın hangi günleri çekim yapılacağı bilgisinin formatı hatalı. |
DealerSale.UpdateSchedule.DaysOfMonthFormatError | Ayın hangi günleri çekim yapılacağı bilgisinin formatı hatalı. |
EX | Beklenmeyen bir hata oluştu |
Başarısız Sonuç Örneği
{
"Data": null,
"ResultCode": "DealerSale.UpdateSchedule.DealerSaleScheduleIdIsRequired",
"ResultMessage": "",
"Exception": null
}