API ציבורי

נקודות קצה

• GET /api/public/records

  רשימה מדופדפת של רשומות שפורסמו.

  פרמטרים של השאילתה

  page

  מספר שלם, ברירת מחדל 1

  limit

  מספר שלם, עד 100

  collection

  מזהה אוסף; כולל צאצאים

  language

  קוד שפה לפי ISO

• GET /api/public/records/:slug

  פרטי רשומה שפורסמה, כולל ישויות גלויות, אבות, אחים וקישורי הקודם והבא.

• GET /api/public/collections

  חטיבות ואוספים ראשיים שפורסמו, כולל תמונות שער וסיכומי תאריכים.

• GET /api/public/collections/:slug

  פרטי אוסף שפורסם, כולל ילדים גלויים, מספר צאצאים ונתיב ניווט.

• GET /api/public/collections/:slug/ead.xml

  ייצוא עזר איתור ב־EAD3 עבור אוסף שפורסם ועומד בתנאים.

• GET /api/public/collections/:slug/finding-aid.pdf

  עזר איתור ב־PDF עבור אוסף שפורסם ועומד בתנאים.

• GET /api/public/entities

  רשומות סמכות המקושרות לרשומות שפורסמו.

  פרמטרים של השאילתה

  page

  מספר שלם

  limit

  מספר שלם

  entity_type

  person|corporate_body|place|subject|family

  search

  טקסט

  letter

  תו אחד

• GET /api/public/entities/:slugOrId

  פרטי רשומת סמכות גלויה, כולל הערות ציבוריות ורשומות שפורסמו.

• GET /api/public/entities/:slugOrId/records

  רשומות שפורסמו ומקושרות לרשומת סמכות גלויה, לפי רמת ביטחון.

  פרמטרים של השאילתה

  limit

  מספר שלם

  exclude

  UUID של רשומה להשמטה

• GET /api/public/entities/:slug/eac.xml

  ייצוא EAC-CPF עבור רשומת סמכות שעומדת בתנאים.

• GET /api/public/search

  חיפוש ברשומות ציבוריות שפורסמו, עם תחיליות השדה person:, place: ו־subject:.

  פרמטרים של השאילתה

  q

  טקסט לחיפוש

  collection

  מזהה אוסף; כולל צאצאים

  person

  שם ישות

  place

  שם מקום

  subject

  שם נושא

  date_start

  שנת התחלה

  date_end

  שנת סיום

  language

  קוד שפה לפי ISO

  sort

  relevance|date|date_desc|title|quality

  page

  מספר שלם

  limit

  מספר שלם

• GET /api/public/cite/:slug

  מחרוזות ציטוט Chicago 17,‏ APA 7 ו־MLA 9 עבור רשומה שפורסמה.

• GET /api/public/images/:orgId/:recordId/thumb

  תמונה ממוזערת ציבורית ב־JPEG, עד 400 פיקסלים בצלע, כאשר הרשאות המדיה מאפשרות זאת.

• GET /api/public/images/:orgId/:recordId/original

  הקובץ המקורי שהועלה, רק כאשר החלטת הגישה האפקטיבית למדיה מאפשרת זאת.

• GET /api/public/iiif/:orgId/:recordId/manifest.json

  מניפסט IIIF Presentation API 3.0 עבור תמונה שפורסמה ועומדת בתנאים. אין בכך טענה ל־IIIF Image API.

• GET /api/public/oai

  נקודת קצה לפי OAI-PMH 2.0 עם שש פעולות הפרוטוקול והפורמטים oai_dc,‏ oai_qdc ו־oai_ead.

• GET /api/public/exhibits

  תערוכות אוצרות שפורסמו.

• GET /api/public/health

  בדיקת תקינות ציבורית של השירות.

• GET /api/public/docs

  תיעוד ה־API הנוכחי בפורמט קריא למכונה.

  פרמטרים של השאילתה

  lang

  en|he