Aday Daveti

Aday Daveti endpoint’i, belirli bir pozisyon için adaylara davet göndermek üzere tasarlanmıştır. Pozisyona ait benzersiz kimliği ve aday e-posta adreslerini içeren bir liste sağlandığında, sistem belirtilen alıcılara otomatik olarak davet e-postaları gönderir. Bu e-postalar, adayların sınav süreçlerine başlamalarını sağlar.

---

Endpoint Genel Bakış

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

---

İ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" // Adayın zaten İK kullanıcısı olarak tanımlı olduğunu belirtir
    },
    {
      "applicantEmail": "[email protected]",
      "invitationID": "6efe44b3-c4fa-477d-a38b-ca280b2cca13",
      "isSuccess": "true", // Davet başarılı bir şekilde gönderildi
      "errorMessage": "Existing Invitation" // Adayın zaten bir aday olarak listelendiğini belirtir. Yeni Davet gönderilmez.
    },
    {
      "applicantEmail": "[email protected]",
      "invitationID": "5ecfef9e-ba28-4c3d-a00c-06780aefda3c",
      "isSuccess": "true",
      "errorMessage": null // Herhangi bir sorun olmadan Davet başarıyla işlenmiştir
    }
  ],
  "success": true,
  "message": null,
  "isResourceKey": true
}

Alan Açıklamaları

• isSuccess:
  Davetin başarıyla gönderilip gönderilmediğini gösterir. false olması durumunda, ilgili errorMessage alanı neden başarısız olduğunu açıklar.

• errorMessage:
  Davetin neden başarısız olduğunu açıklayan bilgi sağlar. Örneğin, "Mevcut İK Kullanıcısı" mesajı, adayın zaten İK kullanıcısı olarak kayıtlı olduğunu ve bu yüzden Davetnin gönderilemediğini belirtir.

• invitationID:
  Gönderilen her Davete ait benzersiz kimlik. Takip ve sorun gidermek için faydalıdır.

• data:
  Davet sonuçlarını içeren bir liste. Her bir giriş, adayın e-posta adresini, Davetnin başarı durumunu ve ilgili hata mesajlarını içerir.

• success:
  Genel operasyonun başarıyla işlenip işlenmediğini belirten bir boolean değer.

---

Kullanım Alanları

• İlk Davetler: Daha önce davet almamış yeni adaylara başlangıç davetleri gönderin.
• Sistematik Onboarding: Birden fazla adayı standart bir davet süreciyle hızlı bir şekilde sisteme dahil edin.
• Operasyonel Şeffaflık: Tüm Davet girişimlerinin kaydedildiğinden ve ayrıntılı sonuçlarla ilişkilendirildiğinden emin olun, böylece denetim ve sorun gidermek daha kolay hale gelir.

---

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 token 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.