Arrangementer

Det kan du bygge

En arrangementsside der fortæller låneren om arrangementet er noget for dem: hvornår og hvor det er, hvad det koster, og hvordan man kommer med. Kræver det billet eller tilmelding, har arrangementet et link, en e-mail, et telefonnummer eller en vejledning. Siden kan også vise de andre datoer i en serie og de værker der hører til arrangementet.

Typisk flow

1. Klienten henter arrangementet med GetContentEvents og dets id i event_ids.
2. Siden viser titlen, tiden fra scheduling, stedet fra branch og location, og adgangen fra admission.
3. Hører arrangementet til en serie, henter klienten de andre arrangementer med GetContentEventsInSeries og series.seriesId.
4. Relaterede værker kommer fra GetWorks når relevantWorks har workIds, eller fra SearchWorks når det angiver en query.
5. Låneren åbner et værk (1.2.1) eller et andet arrangement i serien.

Det leverer API'et

• state er scheduled, cancelled eller finished.
• scheduling er all_day med startDate og endDate, eller time_span med startTime og endTime.
• location er at_branch, et sted inde på filialen, eller external med et name og en valgfri address.
• admission er open, ticket eller registration. Billet og tilmelding har contactInfo med mindst ét af url, email, phone eller info, og en state: ticket_sale_not_open, ticket_sale_open, almost_sold_out eller sold_out.
• En billet har pricing: simple med en tekst, eller price_categories med et amount i mindste møntenhed og en currency i ISO 4217. Et amount på 0 betyder at arrangementet er gratis, men billetten kræves stadig.
• Kun description må have formatering, og kun med HTML-taggene b, i, p, a, ul, ol og li.

Det kan du bygge

En arrangementskalender der viser bibliotekets arrangementer dag for dag, hvert med titel, tid, filial og pris. Filtre for filial, kategori og målgruppe bygges af arrangementerne selv.

Typisk flow

1. Klienten henter arrangementerne i en periode med GetContentEvents, from_date og to_date.
2. Klienten bladrer gennem resultatet med page og size, indtil endOfResults er sand.
3. Klienten grupperer arrangementerne pr. dag og lader låneren filtrere på branch, categories og audiences.
4. Låneren åbner et arrangement (3.2.1).

Det leverer API'et

• En forespørgsel skal have enten to_date eller event_ids. Uden from_date starter provideren fra i dag i sin egen tidszone.
• size er højst 50. total er antallet af arrangementer i hele perioden.
• GetContentEvents har ingen parametre for filial, kategori eller målgruppe. Klienten filtrerer på felterne i hvert arrangement.
• promoted markerer et arrangement som fremhævet, eventuelt mellem en startTime og en endTime.
• Uden ui_language returneres hvert arrangement på alle de sprog det findes på. Samme id på flere sprog er ét arrangement. GetContentConfiguration viser hvilke sprog provideren understøtter.