İçeriğe Geç

Mevzuat Tam Metni

GET /api/v1/library/{id}/text

Mevzuat Tam Metni

Bir regülasyonun çıkarılmış tam metnini döner. Detay uç noktasından (/library/{id}) bilinçli olarak ayrıdır: bir kanun metni yüz binlerce karakter olabiliyor (canlıda 5411 sayılı Bankacılık Kanunu için ~364 KB), bu yüzden bu yanıt önbelleklenmez ve detay yanıtının içine konmaz.

Parametre

  • id — regülasyon doküman ID'si (/library yanıtındaki id).

Yanıt

  • plainText — belgenin okunabilir tam metni. Metin henüz çıkarılmamışsa null.
  • hasText — metnin gerçekten çıkarılıp çıkarılmadığı.

hasText ayrı bir alandır çünkü istemcinin "metin yok" ile "metin boş string" arasında ayrım yapabilmesi gerekir: birincisi boş bir durumdur (belge henüz işlenmemiştir), ikincisi bir veri hatasıdır. hasText: false bir hata değildir — uç nokta yine 200 döner.

404 — belge bulunamadı.

Kullanım önerisi

Yanıt önbelleklenmediği ve tek başına yüzlerce kilobayt olabildiği için bu ucu her sayfa görüntülemede değil, kullanıcı gerçekten tam metni istediğinde çağırın. Listeleme ve özet ihtiyaçları için /library ve /library/{id} çok daha hafiftir.

Yetki ve kota

Api.Library.Detail iznini gerektirir ve detay uç noktasıyla aynı kota kovasından düşer.

Parametreler

İsimKonumTipZorunluAçıklama
id Path uuid Evet Regülasyon doküman ID'si.

Yanıtlar

200 — plainText (çıkarılmış tam metin) ve hasText. hasText=false metnin henüz çıkarılmadığını gösterir — boş durum, hata değil.

404 — Belge bulunamadı.