RequestDetails

İstek Detaylarını Getir

InsurGateway API üzerinden girilen jobId’ye göre isteklerin detaylarını getirir.

Endpoint

GET /api/offline/jobs/{jobId}/request-details

Kimlik Doğrulama

Bu istek, üst koleksiyondan miras alınan Bearer Token kimlik doğrulamasını kullanır. Token, {{authToken}} ortam değişkeninden çözümlenir.

Token’ın aşağıdaki rollerden en az birine ve Read yetkisine sahip olması gerekir:

İş kaydının sigorta şirketi, token içindeki sigorta şirketi kimliklerinden biriyle eşleşmelidir. Token 0 değerini içeriyorsa (Tüm Sigorta Şirketleri) tüm işlere erişilebilir.

Sorgu Parametresi

Örnek İstek

GET https://gatewayapi.insurapps.net/api/offline/jobs/211178/request-details

Yanıt Yapısı

Başarılı Yanıt (200 OK)

Sayfadaki mevcut uzun örnek JSON aynen korunur. Yalnızca iki satır eklenir: Groups dizisinden sonra "OldAndNewData": null ve "Success": true satırından sonra "ErrorExplanation": null. Bu iki alan API tarafından her yanıtta döner ancak mevcut örnekte yer almıyor.

{
  "JobId": 211178,
  "InsuranceCompanyId": 93,
  "Groups": [ /* mevcut örnekteki içerik değişmedi */ ],
  "OldAndNewData": null,
  "InsuranceCompanyKeyGroups": [ /* mevcut örnekteki içerik değişmedi */ ],
  "Success": true,
  "ErrorExplanation": null,
  "Elapsed": 3759
}

Groups[] — KeyGroup

Groups[].Keys[] — Key

OldAndNewData[]

InsuranceCompanyKeyGroups[]

InsuranceCompanyKeyGroups[].InsuranceCompanyKeySettings[]

Kısmi Başarısız Yanıt (200 OK, Success: false)

Platform servisine erişilir ancak servis hata döndürürse istek HTTP 200 ile sonuçlanır; hata bilgisi gövdedeki Success ve ErrorExplanation alanlarında taşınır. Bu durumda Groups boş veya eksik olabilir.

İstemcilerin yalnızca HTTP durum koduna değil, gövdedeki Success alanına da bakması gerekir.

{
  "JobId": 211178,
  "InsuranceCompanyId": 93,
  "Groups": [],
  "OldAndNewData": null,
  "InsuranceCompanyKeyGroups": [],
  "Success": false,
  "ErrorExplanation": "Platform servisinden dönen hata açıklaması",
  "Elapsed": 1204
}

İşin acentesi için tanımlı bir platform servisi çözümlenemezse yanıt gövdesi null olarak döner (HTTP 200).

Hata Yanıt Formatı

401 dışındaki tüm hatalar aşağıdaki ortak gövde ile döner:

{
  "Status": false,
  "Code": "ErrorCode",
  "Message": "Error description",
  "Response": null
}

Doğrulama hatalarında Response alanı alan bazlı hata listesi içerir.

Doğrulama Hatası (400 Bad Request)

jobId değeri 1’den küçük gönderildiğinde döner.

{
  "Status": false,
  "Code": "Validation.General",
  "Message": "One or more validation errors occurred",
  "Response": [
    {
      "Field": "JobId",
      "Message": "JobId must be greater than or equal to 1."
    }
  ]
}

jobId sayısal olmayan bir değerle gönderilirse (/api/offline/jobs/abc/request-details) route eşleşmez ve 404 Not Found döner.

Yetkilendirme Hataları

Token geçerli ancak gerekli rol ya da Read yetkisi yoksa 403 Forbidden gövdesiz döner. Token geçerli ve rol uygun, fakat token içinde hiç sigorta şirketi ataması yoksa aşağıdaki gövde ile 403 Forbidden döner:

{
  "Status": false,
  "Code": "OfflineJobs.InsuranceCompanyNotFound",
  "Message": "No valid insurance company assignment found in token.",
  "Response": null
}

İş Bulunamadı (404 Not Found)

{
  "Status": false,
  "Code": "RequestDetail.NotFound",
  "Message": "Job with ID 999999 not found.",
  "Response": null
}

Bu hata hem iş kaydı hiç yokken hem de iş kaydı token’daki sigorta şirketlerine ait değilken döner. Başka bir şirkete ait işin varlığı bilgisi sızdırılmaz.

Sunucu Hatası (500 Internal Server Error)

Platform servisi çağrısı sırasında beklenmeyen bir hata oluştuğunda döner.

{
  "Status": false,
  "Code": "RequestDetail.Failure",
  "Message": "Request detail okunurken hata: {hata mesajı}",
  "Response": null
}

Hata Kodları Referansı

HTTP Durum Kodları