Create Message
İşe Mesaj Gönder
Endpoint Bilgileri
Sigorta şirketinin, bir iş üzerinden platformdaki ilgili kullanıcıya mesaj ve isteğe bağlı ek dosya iletmesi için kullanılır.
Başarılı istekte işe Mesaj (Message) tipinde aksiyon kaydı eklenir, aksiyon platforma iletilir, varsa ek dosyalar kaydedilir ve acentede mailing kapalı değilse platform kullanıcısına bilgilendirme maili gönderilir.
Mesaj işin aşamasını değiştirmez ve işin her aşamasında gönderilebilir; kaynak aşama kısıtı yoktur.
Route Parametreleri
İstek Modeli — CreateMessageRequest
Ek Dosya — FileRequest
* Bu alanlar yalnızca
Attachmentsdizisi gönderildiğinde doğrulanır. Dosya türü kısıtı yoktur; uzantı ve içerik PDF olmak zorunda değildir. EklerDiğer(Other) doküman tipiyle kaydedilir.
İş Kuralları
State geçişi sırasında sırasıyla aşağıdaki kontroller yapılır:
-
Mesajı karşılayacak platform kullanıcısı bulunmalıdır:
-
İş
Prim Reddedildiaşamasındaysa → sonPrim İsteğini gönderen kullanıcı -
İş
Toplu Prim Reddedildiaşamasındaysa → sonToplu Prim İsteğini gönderen kullanıcı -
Diğer tüm aşamalarda → işteki son platform kullanıcısı aksiyonunu gönderen kullanıcı
-
-
Mesajı gönderen kullanıcı sistemde kayıtlı olmalıdır.
-
Aksiyon platforma iletilebilmelidir.
Geri alma davranışı: 3. kural başarısız olursa oluşturulan aksiyon kaydı silinir; ek dosyalar kaydedilmez ve mail gönderilmez.
Yanıt
201 Created — Başarılı Yanıt
Gövde boştur.
Hata Senaryoları
400 Bad Request — Doğrulama Hatası
İstek modeli doğrulamadan geçemediğinde döner. Hatalı alanlar Response içinde listelenir.
400 Bad Request — İstek Gövdesi Boş
İstek gövdesi boş, yalnızca boşluk veya null gönderildiğinde döner. Yanıt standart zarf formatında değildir; text/plain olarak yalnızca hata metnini içerir.
400 Bad Request — Geçersiz JSON
İstek gövdesi geçerli bir JSON olmadığında döner. Yanıt text/plain olarak JSON ayrıştırıcısının hata metnini içerir; metin, hatanın konumuna göre değişir.
415 Unsupported Media Type — Content-Type Eksik
Content-Type: application/json header’ı gönderilmediğinde döner.
403 Forbidden — Geçerli Sigorta Şirketi Ataması Bulunamadı
Token’da geçerli bir sigorta şirketi ataması bulunmadığında döner.
403 Forbidden — Kullanıcı Kimliği Çözümlenemedi
Token’dan kullanıcı kimliği okunamadığında döner.
403 Forbidden — İşe Erişim Reddedildi
İş, çağıranın sahipliğinde değilse döner.
403 Forbidden — Rol veya Yetki Yetersiz
Kullanıcı tanınan rollerden birine sahip değilse ya da Create yetkisi yoksa döner. Gövde boştur.
401 Unauthorized — Token Yok veya Geçersiz
Token gönderilmediğinde, geçersiz olduğunda veya süresi dolduğunda döner. Gövde boştur. Süresi dolmuş token için yanıtta Token-Expired: true header’ı bulunur.
404 Not Found — İş Bulunamadı
Belirtilen jobId ile bir iş bulunamadığında döner.
500 Internal Server Error — State Geçişi Başarısız
Mesajı karşılayacak platform kullanıcısı bulunamazsa, gönderen kullanıcı sistemde kayıtlı değilse veya aksiyon platforma iletilemezse döner. Message alanı iş kuralı hatasının detayını içerir.
Aksiyon platforma iletilemediğinde oluşturulan aksiyon silinir; işte kalıcı bir değişiklik olmaz.
500 Internal Server Error — Beklenmeyen Hata
Geçiş sırasında iş kuralı dışında bir hata oluştuğunda döner.
500 Internal Server Error — İşlenmeyen Hata
State geçişinden önce beklenmeyen bir hata oluştuğunda (örn. iş okunurken veritabanı hatası) döner. Gövde boştur.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
