İçeriğe geç

Sayfalama

İmleçle sayfalama, sayfa boyutu ve updated_since ile eşitleme.

Geliştirici belgesi

Liste uçları sayfalıdır. Yanıt her zaman aynı zarftadır:

{ "data": [], "next_cursor": null }
  • limit: sayfa boyutu. Varsayılan 25, en çok 100; daha büyük değer en çoğa iner.
  • next_cursor: sonraki sayfanın imleci. Son sayfada null'dır.
  • cursor: bir önceki yanıtın next_cursor değeri. İmleç opaktır ve imzalıdır: içini okumaya ya da değiştirmeye çalışmayın. Aynı anahtarla (ya da onun döndürülmüş hâliyle) ve aynı süzgeçle gönderilir; süzgeç değişirse 400 cursor_invalid döner. İmlecin ömrü 3 gündür.
  • Toplam kayıt sayısı dönmez.

Sıra

Listeler kimliğe göre sıralıdır ve sıra kararlıdır: sayfalar arasında kayıt atlanmaz, yinelenmez. Sıralama parametresi yoktur; kimlik sırası "en yeni önce" anlamına gelmez.

Eşitleme: updated_since

Çalışan, izin talebi ve vardiya ataması listeleri updated_since süzgecini alır: yalnız updated_at değeri verilen andan büyük ya da eşit olan kayıtlar döner.

  • Değer saat dilimi taşıyan ISO 8601 anıdır (2026-06-16T08:00:00Z); yalnız gün 400 alır.
  • Süzgeç kapsayıcıdır: son gördüğünüz updated_at değerini gönderin ve kayıtları kimlikle tekilleştirin.
  • Çalışanın sınıflı alanları (T.C. kimlik numarası, IBAN, ücret, kişisel bilgiler) ayrı tutulur ve değişmeleri updated_at değerini oynatmaz. Bu alanları eşitliyorsanız kaydı yeniden okuyun.
  • Silinen bir vardiya ataması ya da yayımı geri alınan bir plan updated_since ile görünmez; bunu shift.assignment.changed ve shift.plan.published olayları bildirir (Olay kataloğu).

Örnek: bütün çalışanları gezmek

CURSOR=""
while :; do
  curl -sS "$BIIK_API_URL/api/v1/employees?limit=100${CURSOR:+&cursor=$CURSOR}" \
    -H "Authorization: Bearer $BIIK_API_KEY" > sayfa.json
  jq -r '.data[].id' sayfa.json
  CURSOR=$(jq -r '.next_cursor // empty' sayfa.json)
  [ -z "$CURSOR" ] && break
done
cat sayfa.json

Beklenen yanıt: 200 Başarılı

Örnek yanıt (OpenAPI belgesinden)
{
  "data": [
    {
      "id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "org_unit_id": "c4a1e2b3-7d6f-4e5a-9b8c-1f2e3d4c5b6a",
      "job_title_id": "9e7d6c5b-4a39-4821-8f70-6e5d4c3b2a19",
      "position_id": null,
      "manager_id": null,
      "first_name": "Deniz",
      "last_name": "Kaya",
      "work_email": "[email protected]",
      "status": "active",
      "employment_type": "full_time",
      "hire_date": "2026-03-02",
      "service_start_date": null,
      "sgk_entry_date": null,
      "probation_end": "2026-05-02",
      "is_demo": false,
      "created_at": "2026-02-24T09:30:00.000Z",
      "updated_at": "2026-03-02T07:00:00.000Z"
    }
  ],
  "next_cursor": null
}