Skip to main content
/v1/holidays kaynağı kliniğin kapalı olduğu günleri ve saatleri yönetir. İki tür kayıt döner: Flextell’in sağladığı resmî tatiller ve sizin eklediğiniz klinik tatilleri. Resmî tatillerin adını, tarihini ve türünü değiştiremezsiniz. Yalnızca kliniğiniz için randevu engelleme tercihini geçersiz kılabilirsiniz. Her istek Authorization: Bearer <access_token> ve X-Tenant: <tenant_id> başlıklarını taşır. Bkz. Klinikler ve X-Tenant.

Endpoint özeti

DELETE /v1/holidays/{id}/override isteği holidays:delete scope’unu ister, ancak izin olarak Delete:Holiday değil Update:Holiday arar. Token’ınızda scope, rolünüzde Update:Holiday izni olmalıdır.
Kayıt silme kalıcıdır. Tatiller Geri Dönüşüm Kutusu’na gitmez.

Tatil türleri

Her tatilin bir type değeri ve arayüzdeki karşılığı olan type_label alanı vardır. source alanı kaydın kaynağını verir.

Önemli alanlar

Yanıttaki değerler her zaman kliniğiniz için geçerli olanlardır. Bir resmî tatil için tercih kaydettiyseniz blocks_appointments, is_full_day, starts_at ve ends_at sizin değerlerinizi gösterir.

Listeleme

GET /v1/holidays kayıtları date alanına göre sıralı döner. Sayfalama kuralları için Sayfalama sayfasına bakın. Bu kaynakta per_page varsayılanı 25, en yüksek değer 100’dür.

Klinik tatili ekleme

POST /v1/holidays yalnızca kliniğinize ait bir tatil oluşturur. Başarılı yanıt 201 döner ve kayıtta source: tenant, is_global: false olur.
string
gerekli
Y-m-d biçiminde tarih.
string
gerekli
En fazla 255 karakter.
string
gerekli
national, religious, observance veya custom.
boolean
gerekli
true ise tatil randevuyu engeller, false ise yalnızca bilgi amaçlıdır.
boolean
gerekli
true ise gün boyu kapalı, false ise kısmi kapanış.
string
H:i biçiminde başlangıç saati. is_full_day false ise zorunludur.
string
H:i biçiminde bitiş saati, starts_at değerinden sonra olmalıdır. Boş bırakırsanız kapanış günün sonuna kadar sürer.
Saatler kliniğin yerel saatidir. Aşağıdaki örnek, 31 Aralık’ta saat 13:00’ten günün sonuna kadar klinik kapanışını ekler.
Bir klinik tatilini PUT /v1/holidays/{id} ile güncellersiniz. Gövdede yukarıdaki alanlardan istediğinizi gönderebilirsiniz. Resmî bir tatilin kimliğini bu endpoint’e verirseniz 404 (Tenant holiday not found) alırsınız. Resmî tatiller için aşağıdaki geçersiz kılma endpoint’ini kullanın.

Resmî tatili geçersiz kılma

Resmî tatilin adı, tarihi ve türü değişmez. Kliniğiniz yine de o gün çalışıyorsa ya da yalnızca belirli saatlerde kapalıysa tercihinizi PUT /v1/holidays/{id}/override ile kaydedersiniz.
boolean
gerekli
Tatil randevuyu engellesin mi.
boolean
gerekli
Kapanış gün boyu mu.
string
Kısmi kapanış başlangıcı (H:i).
string
Kısmi kapanış bitişi (H:i).
Geçersiz kılma gövdesinde name, date veya type gönderirseniz istek 422 ile reddedilir.
Örnek: bir resmî tatilde (id 123) kliniği açık tutmak için randevu engelini kapatın.
curl
Yanıt, geçerli değerleri içeren tatil kaydıdır ve has_tenant_override değeri true olur. Tercihi silmek için DELETE /v1/holidays/{id}/override çağırın. Yanıt, varsayılan değerlere dönmüş tatili verir. Panelde aynı işlem Varsayılana Dön düğmesidir. Bkz. Tatiller (panel). Klinik tatilleri için tercih endpoint’leri kullanılmaz. Onların kimliğiyle çağırırsanız 404 (Global holiday not found) döner.

Etkileri

Tatiller randevu akışlarını şöyle etkiler. Uygun saat ve takvim yanıtlarının ayrıntıları için Randevu uygunluğu ve takvim sayfasına bakın. Ayar yönetimi için Ayarlar sayfasına bakın.
closed_periods ve takvimdeki holiday öğeleri yalnızca ana anahtar açıkken kapanış olarak işlenir. Ayar kapalıyken takvim tatili göstermeye devam eder, ancak kapalı saymaz.

Hatalar

Genel hata biçimi için Hata kodları sayfasına bakın. Scope listesi için Scope’lar, izin mantığı için İzinler ve görünürlük sayfasına bakın.