Arrangementshandlingerne læser arbejdsområdets arrangementer, holder en deltagerliste i takt med et andet system og registrerer fremmøde efter arrangementet. API’et følger de samme regler som Floral-appen: kapacitet, venteliste, tilmeldingsperiode og afslutning af fremmøde fungerer ens.
Forudsætninger
- Arbejdsområdet har tilføjelsen Arrangementer, og tokenets ejer kan bruge Work i arbejdsområdet.
- Tokenet har
events:read for at læse arrangementer og deltagere og events:write for at ændre dem. Hvert scope giver kun sin egen adgang; et skrivetoken kan ikke læse.
- Du ser kun de arrangementer, som tokenets ejer kan se i Floral. Et arrangement eller en deltager, du ikke kan se, giver
404 NOT_FOUND, præcis som hvis det ikke fandtes.
Hvis arbejdsområdet ikke har adgang til tilføjelsen Arrangementer, giver alle arrangementshandlinger 404 FEATURE_DISABLED.
Angiv værdierne én gang i din shell, før du kører eksemplerne:
Brug en personlig adgangsnøgle, der er oprettet til arbejdsområdet. Eksemplerne bruger kunstige id’er og værdier. Erstat dem med værdier fra dit arbejdsområde.
Gem FLORAL_TOKEN i et hemmelighedslager uden for lokal udvikling. Læg det aldrig i kildekode eller logs.
Hent og filtrér arrangementer
Arrangementslisten bruger uigennemsigtig cursor-paginering med højst 50 elementer pr. side. Filtrér efter planlægningsstatus, afslutning af fremmøde, ejer eller et lokalt datointerval.
Send en nextCursor, der ikke er null, som cursor med de samme filtre og den samme sortering for at hente næste side.
Hent et arrangement og dets version
Den stærke ETag-header og feltet version indeholder arrangementets aktuelle version. Du skal bruge den for at afslutte fremmødet.
Hent deltagere
Deltagere returneres i tilmeldingsrækkefølge. Filtrér efter tilmeldingsstatus, fremmødestatus eller CRM-matchstatus.
Hver deltager har et UUID som id og sin egen version. Objektet responses indeholder kun almindelige tilmeldingssvar.
Læs begrænsede svar
Svar på felter, der er markeret som begrænsede, for eksempel kost- eller tilgængelighedsbehov, er aldrig en del af deltagerressourcen. Kun arrangementets arrangør eller en administrator i arbejdsområdet kan læse dem gennem en separat handling:
Alle andre får 403 FORBIDDEN. Gem kun svarene, så længe du har brug for dem til arrangementets logistik.
Tilmeld en deltager
Tilmelding kræver en Idempotency-Key. Svarene valideres mod arrangementets tilmeldingsformular.
En gennemført tilmelding giver 201 med en Location-header og deltagerens ETag. Er arrangementet fuldt og har venteliste, oprettes deltageren med status WAITLISTED og en waitlistPosition. Er tilmeldingen lukket, eller er arrangementet fuldt uden venteliste, giver handlingen 409 CONFLICT og opretter intet.
Opdatér en deltager
Send kun de felter, du vil ændre, sammen med deltagerens nyeste ETag. null rydder et valgfrit felt.
Kun arrangementets arrangør eller en administrator i arbejdsområdet kan ændre svar på begrænsede felter. Et kald fra alle andre, der indeholder et begrænset felt, giver 403 FORBIDDEN og ændrer intet.
Registrér fremmøde
Registrér op til 500 tilmeldte deltagere i ét kald. Registreringen kræver en Idempotency-Key, men ingen If-Match, så flere personer kan tjekke gæster ind samtidig.
Et kald gennemføres helt eller slet ikke. Det afvises med 404 NOT_FOUND, hvis et ID ikke hører til arrangementet, med 409 INVALID_STATE, hvis en deltager ikke er tilmeldt, og med 409 INVALID_STATE, når fremmødet er afsluttet. Svaret viser de deltagere, hvis status blev ændret, og dem, der allerede havde den.
Afslut fremmødet
Når fremmødet afsluttes, låses det til opfølgning. Handlingen kræver arrangementets nyeste ETag og en Idempotency-Key. Angiv de tilmeldte deltagere, der ikke mødte op; alle andre, der stadig ikke er registreret, forbliver UNKNOWN.
Et arrangement, hvis fremmøde allerede er afsluttet, giver 409 INVALID_STATE.
Ret afsluttet fremmøde
Efter afslutningen retter du én deltager ad gangen med en begrundelse. Send deltagerens nyeste ETag.
Floral bevarer den tidligere fremmøderegistrering og markerer den som erstattet, så rettelsernes historik kan revideres.
Floral beskytter skrivekald med to uigennemsigtige værdier:
- Send en unik
Idempotency-Key, når handlingen kræver det. Et identisk nyt forsøg med samme nøgle gentager resultatet i 24 timer. Hvis nøglen genbruges med et andet kanonisk input til samme handling, får du 409 IDEMPOTENCY_CONFLICT.
- Send den nyeste stærke
ETag som If-Match, når en eksisterende ressource ændres. En forældet værdi giver 412 VERSION_CONFLICT, og en manglende værdi giver 428 PRECONDITION_REQUIRED.
Behold anførselstegnene omkring en ETag, og erstat den gemte værdi efter hvert gennemført skrivekald. Se Driftssikkerhed og nye forsøg for alle regler om nye forsøg. 