Aday Zorunlu Davet

Aday Zorunlu Davet endpoint’i, belirli bir pozisyon için adaylara tekrar Davet göndermek üzere tasarlanmıştır. Standart Davet gönderim sürecinden farklı olarak, bu endpoint daha önce Davet gönderilmiş alıcıları hedef alır. Bu sayede, daha önce Davet gönderilmiş ancak yanıt alınmamış veya Davetyi kaçırmış olan adaylara yeniden davet gönderilir. Bu işlem, organizasyonların iletişimlerini net bir şekilde sürdürebilmelerini ve işe alım süreçlerini düzenlemelerini sağlar.

---

Endpoint Genel Bakış

• HTTP Yöntemi: POST
• Endpoint URL:
  https://api.vinter.me/api/v1/Invitation/ForceInvitation

---

İstek Başlıkları

Başlık Adı	Açıklama	Örnek Değer
X-Api-Key	Organizasyonel kimlik doğrulama için kullanılan API anahtarı.	api_key
Content-Type	İstek gövdesinin medya tipini belirtir.	application/json

---

İstek Gövdesi

İstek gövdesi, aşağıdaki özellikleri içeren geçerli bir JSON nesnesi olmalıdır:

Parametre Adı	Tür	Gerekli	Açıklama
positionId	String	Evet	Davetlerin gönderileceği pozisyona ait benzersiz kimlik.
applicantEmails	Dizi	Evet	Davet edilecek adayların e-posta adreslerinin listesi.

Örnek İstek Gövdesi

{
  "positionId": "2ec6acd7-b976-4a58-aff4-e32c4121d73f",
  "applicantEmails": [
    "[email protected]",
    "[email protected]",
    "[email protected]"
  ]
}

---

Yanıt Formatı

İsteğin başarılı bir şekilde işlenmesi durumunda, API aşağıdaki yapıda bir JSON yanıt döndürür:

{
  "data": [
    {
      "applicantEmail": "[email protected]",
      "invitationID": "e9e4154c-8ba6-4199-b25b-b734dd74ef1d",
      "isSuccess": "false",
      "errorMessage": "Existing HR User"
    },
    {
      "applicantEmail": "[email protected]",
      "invitationID": "6efe44b3-c4fa-477d-a38b-ca280b2cca13",
      "isSuccess": "true",
      "errorMessage": null
    },
    {
      "applicantEmail": "[email protected]",
      "invitationID": "5ecfef9e-ba28-4c3d-a00c-06780aefda3c",
      "isSuccess": "true",
      "errorMessage": null
    }
  ],
  "success": true,
  "message": null,
  "isResourceKey": true
}

---

Detaylı Alan Açıklamaları

• isSuccess:
  Bu alan, belirli bir adaya yeniden davet gönderiminin başarıyla yapılıp yapılmadığını gösterir. true değeri, e-postanın başarıyla yeniden gönderildiğini; false değeri ise işlemin bir hata ile karşılaştığını belirtir.

• errorMessage:
  Eğer isSuccess değeri false ise, bu alan yeniden davet gönderiminin neden başarısız olduğunu açıklayan bir mesaj içerir. Örneğin, "Mevcut İK Kullanıcısı" mesajı, alıcının zaten sistemde bir İK kullanıcısı olarak tanımlı olduğunu ifade eder ve bu nedenle yeniden Davet gönderilememiştir.

• invitationID:
  Her davet gönderim girişimine özel bir kimlik. Bu kimlik, davet gönderim girişimlerini denetlemek veya sorun gidermek için kullanılabilir.

• data:
  Her bir alıcı e-postası için bir sonuç içeren listeyi içerir. Liste içindeki her bir giriş, alıcının e-posta adresini, benzersiz invitationID değerini ve ilgili davet için başarı durumunu ve hata mesajını içerir.

• success:
  Genel operasyonun başarıyla işlenip işlenmediğini gösterir. Bireysel Davetler başarısız olsa bile, bu alan isteğin işlenip işlenmediğini belirtir.

---

Kullanım Alanları

• Yeniden Etkileşim: Daha önce Davet gönderilmiş ancak yanıt vermeyen adayları yeniden davet ederek, yetenek havuzunu aktif tutmak.
• Hata Çözümü: Daha önce yanlış e-posta adresi gibi sorunlar yaşayan adaylar için, gerekli düzeltmeler yapıldıktan sonra Davetlerin tekrar gönderilmesi.
• İletişim Sürekliliği: Adaylarla tutarlı bir iletişim kanalı sürdürerek, başvuru durumları hakkında en güncel bilgilerin kendilerine ulaştığından emin olunması.

---

Hata Kodları

HTTP Kodu	Durum	Açıklama
400	Geçersiz İstek	İstek geçersiz veya yanlış biçimlendirilmiş parametreler içeriyor.
401	Yetkilendirme Başarısız	API anahtarı eksik veya geçersiz olduğu için kimlik doğrulama başarısız oldu.
404	Bulunamadı	İstenen kaynak (ör. pozisyon) bulunamadı.
500	Dahili Hata	İstek işlenirken dahili bir sunucu hatası meydana geldi.