OutSourceProcess Usages

## OutSourceProcess Usages Bir sigorta şirketine ait OutSourceProcess servisi çağrılmadan önce, ilgili servise **gönderilmesi gereken alanların (key)** ve bu alanların bağlı olduğu **parametre tanımlarının** listesini döndürür. ### Uç Nokta (Endpoint) `GET {{baseUrl}}/api/OutSourceProcesses/usages` --- ### Kimlik Doğrulama Bu uç nokta geçerli bir JWT erişim token'ı gerektirir. Token, [Authentication Login](https://docs.insurgateway.com/insurgateway-api/authentication/login) servisinden alınır ve `Authorization` başlığında gönderilir. | Başlık | Tür | Zorunlu | Açıklama | | --- | --- | --- | --- | | `Authorization` | string | ✅ | `Bearer` biçiminde erişim token'ı. | --- ### Kullanım Bu servis, OutSourceProcess servisi çağrılmadan önce hangi alanların gönderilmesi gerektiğini öğrenmek için kullanılır. Önerilen akış: 1. `Authentication Login` servisinden token alınır. 2. İlgili sigorta şirketi ve OutSourceProcess için bu servis çağrılarak `Keys` listesi elde edilir. 3. `ParameterId` değeri `null` olmayan alanlar için `ParameterValues` servisinden geçerli değer listesi çekilir ve kullanıcıya seçim olarak sunulur. 4. Toplanan değerler `KeyId` eşleşmeleriyle birlikte OutSourceProcess servisine gönderilir. > 💡 Alan tanımları sigorta şirketine ve OutSourceProcess'e göre değişebildiğinden, entegrasyonda alanların sabit kodlanması yerine bu servisten dinamik olarak okunması önerilir. --- ### İstek Parametreleri (Query Parameters) | Parametre | Tür | Zorunlu | Açıklama | | --- | --- | --- | --- | | `insuranceCompanyId` | integer | ✅ | Sorgunun yapılacağı sigorta şirketinin kimliği. | | `serviceOperationId` | integer | ✅ | Servis operasyonu türü. `10` = `GetOutSourceProcess`. | | `outsourceProcessId` | integer | ⚠️ Koşullu | Çağrılacak OutSourceProcess kaydını belirtir. `serviceOperationId` değeri `10` olduğunda **zorunludur**. | **Örnek İstek:** ``` GET {{baseUrl}}/api/OutSourceProcesses/usages?insuranceCompanyId=<SIRKET_ID>&serviceOperationId=10&outsourceProcessId=6 Authorization: Bearer <token> ``` --- ### Başarılı Yanıt (200 OK) Başarılı bir istekte HTTP `200 OK` durum kodu ile bir dizi (array) döner. Dizinin her elemanı bir servis operasyonuna ait alan ve parametre tanımlarını içerir. | Alan | Tür | Açıklama | | --- | --- | --- | | `ServiceOperation` | string | Tanımların ait olduğu servis operasyonunun adı. | | `Keys` | array | İlgili servis çağrılırken sağlanması gereken alanların listesi. | | `Parameters` | array | `Keys` içinde önceden tanımlı bir değer listesine bağlı olan alanların parametre tanımları. | **`Keys`** **nesnesi:** | Alan | Tür | Açıklama | | --- | --- | --- | | `KeyId` | integer | Alanın benzersiz kimliği. Servis çağrısında bu kimlik ile değer gönderilir. | | `KeyName` | string | Alanın görünen adı. | | `ParameterId` | integer | null | | `ParameterName` | string | null | **`Parameters`** **nesnesi:** | Alan | Tür | Açıklama | | --- | --- | --- | | `ParameterId` | integer | Parametrenin benzersiz kimliği. | | `ParameterName` | string | Parametrenin adı. | **Örnek Başarılı Yanıt:** ``` json [ { "ServiceOperation": "GetOutSourceProcess", "Keys": [ { "KeyId": 1, "KeyName": "Sigortalı TC Kimlik No", "ParameterId": null, "ParameterName": null }, { "KeyId": 4, "KeyName": "Plaka İl Kodu", "ParameterId": 2, "ParameterName": "İller" }, { "KeyId": 5, "KeyName": "Plaka", "ParameterId": null, "ParameterName": null }, { "KeyId": 38, "KeyName": "Araç Kullanım Şekli", "ParameterId": 8, "ParameterName": "Kasko Araç Kullanım Şekli" } ], "Parameters": [ { "ParameterId": 2, "ParameterName": "İller" }, { "ParameterId": 8, "ParameterName": "Kasko Araç Kullanım Şekli" } ] } ] ``` --- ### Hatalı Yanıt (400 Bad Request) Zorunlu parametrelerden biri gönderilmediğinde HTTP `400 Bad Request` durum kodu ile aşağıdaki metin döner: **Örnek Hatalı Yanıt:** ``` insuranceCompanyId ve serviceOperationId zorunludur. ``` > ⚠️ `serviceOperationId` değeri `10` gönderildiğinde `outsourceProcessId` alanının da sağlanması gerekir; aksi hâlde istek `400` ile sonuçlanır. --- ### Hatalı Yanıt (401 Unauthorized) Geçerli bir token gönderilmediğinde HTTP `401 Unauthorized` durum kodu döner. Token'ın süresi dolmuşsa `Refresh Token` servisi ile yenilenmelidir. --- ### Hatalı Yanıt (404 Not Found) Verilen kriterlere uygun bir servis operasyonu bulunamadığında HTTP `404 Not Found` durum kodu döner. Bu durum genellikle ilgili sigorta şirketi için tanımlı olmayan bir `outsourceProcessId` gönderildiğinde oluşur.