İçeriğe geç

Vardiya

Vardiya uçları: parametreler, alanlar ve örnek yanıtlar.

Geliştirici belgesi

Vardiya atamalarını listeler

GET /api/v1/shift-assignments

Kapsam: shifts:read

Yayımlanmış planların geçerli atamaları; taslak plan ve bekleyen değişiklik talebi dönmez. Silinen atama updated_since ile görünmez: shift.assignment.changed olayı çalışanı ve günü bildirir, o gün employee_id, from ve to ile yeniden okunur. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez. Örnek kayıtlar listeye girmez.

Parametreler

shift_assignments.list: Parametreler
AlanTürAçıklama
employee_id (sorgu)string (uuid)Yalnız bu çalışanın atamaları.
from (sorgu)string (date)Bu günden önce olmayan atamalar (YYYY-MM-DD).
to (sorgu)string (date)Bu günden sonra olmayan atamalar (YYYY-MM-DD).
updated_since (sorgu)string (date-time)Yalnız updated_at değeri bu andan büyük ya da eşit olan kayıtlar (saat dilimi taşıyan ISO 8601). Kapsayıcıdır: son gördüğünüz updated_at değerini gönderin ve kimlikle tekilleştirin.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

shift_assignments.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
org_unit_idstring (uuid)zorunlunull olabilirPlanın birimi; birimsiz planda null.
employee_idstring (uuid)zorunlu
shift_type_idstring (uuid)zorunlu
shift_codestringzorunluVardiya türünün kısa kodu.
datestring (date)zorunluVardiyanın başladığı gün.
start_timestringzorunlu
end_timestringzorunluBitiş saati (SS:DD); başlangıçtan küçükse ertesi gündür.
break_minutesintegerzorunlu
sourcestringzorunlumanual: plan ekranından; roster: çizelge yayımından. Değerler: manual, roster
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "data": [
    {
      "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "org_unit_id": "c4a1e2b3-7d6f-4e5a-9b8c-1f2e3d4c5b6a",
      "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "shift_type_id": "2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
      "shift_code": "G",
      "date": "2026-07-06",
      "start_time": "08:00",
      "end_time": "16:00",
      "break_minutes": 60,
      "source": "manual",
      "is_demo": false,
      "created_at": "2026-06-25T14:00:00.000Z",
      "updated_at": "2026-06-25T14:00:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek vardiya atamasını döndürür

GET /api/v1/shift-assignments/{id}

Kapsam: shifts:read

Anahtarın görmediği kayıt ile var olmayan kayıt aynı 404 yanıtını alır.

Parametreler

shift_assignments.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluAtamanın kimliği.

Yanıtlar

200 Başarılı

shift_assignments.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
org_unit_idstring (uuid)zorunlunull olabilirPlanın birimi; birimsiz planda null.
employee_idstring (uuid)zorunlu
shift_type_idstring (uuid)zorunlu
shift_codestringzorunluVardiya türünün kısa kodu.
datestring (date)zorunluVardiyanın başladığı gün.
start_timestringzorunlu
end_timestringzorunluBitiş saati (SS:DD); başlangıçtan küçükse ertesi gündür.
break_minutesintegerzorunlu
sourcestringzorunlumanual: plan ekranından; roster: çizelge yayımından. Değerler: manual, roster
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
  "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
  "org_unit_id": "c4a1e2b3-7d6f-4e5a-9b8c-1f2e3d4c5b6a",
  "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "shift_type_id": "2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
  "shift_code": "G",
  "date": "2026-07-06",
  "start_time": "08:00",
  "end_time": "16:00",
  "break_minutes": 60,
  "source": "manual",
  "is_demo": false,
  "created_at": "2026-06-25T14:00:00.000Z",
  "updated_at": "2026-06-25T14:00:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout