API - Påmeldinger
Dette er et standard API som kan brukes til å hente ut eksisterende påmeldinger for en innlogget deltager.
Du kan bruke parameterne til å tilpasse resultatet slik du ønsker.
API-et returnerer en liste med påmeldinger i JSON-format.
Forespørsel (request)
| URL | /api/v1/certifications |
| Method | GET |
| Autentisering | Basic Auth Samme brukernavn og passord som du bruker for å logge inn i admin. Du kan gjerne opprette en egen bruker som bare skal brukes til API-et. |
Parametere:
| Navn | Type | Påkrevd? | Beskrivelse |
|---|---|---|---|
| user_id | string | Påkrevd, hvis ikke group_id er brukt | Unik bruker-id. Kan også være en kommaseparert liste med flere bruker-ider. Format og verdi er avhengig av SSO-integrasjonen, men vi anbefaler UUID-format (eks. f81d4fae-7dec-11d0-a765-00a0c91e6bf6) eller lignende. |
| group_id | string | Påkrevd, hvis ikke user_id er brukt. | Unik gruppe-id (for eksempel firma). Format og verdi er avhengig av SSO-integrasjonen, men vi anbefaler UUID-format (eks. f81d4fae-7dec-11d0-a765-00a0c91e6bf6) eller lignende. |
| status | string | Valgfri | Kommaseparert liste med deltagerstatuser. Eksempel: registered,confirmed Gyldige verdier: inProgress (Importert), invited (Invitert), reserved (Reservert), registered (Påmeldt), confirmed (Bekreftet), list (Venteliste), declined (Avslått), deregistered (Avmeldt), expired (Utgått) |
| passed | string | Valgfri | Deltageren har bestått. Gyldige verdier: true, false |
| from_date | string | Valgfri | Aktiviteten starter etter dato og tid (eller bare dato). Eksempel: 2020-08-14 00:00 |
| to_date | string | Valgfri | Aktiviteten slutter før dato og tid (eller bare dato). Eksempel: 2020-08-14 00:00 |
| per_page | number | Valgfri | Maks antall påmeldinger per side i lista. Standard: 25 |
| page | number | Valgfri | Sidenummer |
Svar (response)
Api-et returnerer statuskode 200 og et array med påmeldinger i JSON-format.
Felt som hentes ut for hver påmelding (under "data"):
| Feltnavn (JSON) | Beskrivelse/feltnavn |
|---|---|
| id | Aktivitets-ID (løpenummer) |
| title | Tittel |
| user_id | Bruker-id |
| group_id | Gruppe-id |
| user_name | Brukerens navn |
| starts_at | Starttidspunkt |
| ends_at | Sluttidspunkt |
| address_name | Sted |
| address | Adresse |
| postal_zone | Postnummer |
| postal_area | Poststed |
| country | Land |
| status | Deltagerstatus |
| passed | Har deltageren bestått? |
| links.self | Lenke til påmeldingsskjema/bekreftelsesside |
| links.certification | Lenke til kursbevis (hvis bestått) |
Du finner lenker for å bla til andre sider under "links".
| Feltnavn (JSON) | Beskrivelse |
|---|---|
| first | Lenke til første side |
| last | Lenke til siste side |
| prev | Lenke til forrige side |
| next | Lenke til neste side |
I tillegg finner du mer informasjon om paginering under "meta".
| Feltnavn (JSON) | Beskrivelse |
|---|---|
| current_page | Gjeldende sidetall |
| from | Nummer på første element i lista |
| last_page | Siste sidetall |
| links | Array med linker til forrige, alle sidetall og neste side |
| path | Lenke til dette API-et |
| per_page | Antall linjer som vises per side |
| to | Nummer på siste element i lista |
| total | Totalt antall elementer |
Merk:
API-et leverer et sub-sett av feltene som er tilgjengelige på aktiviteter og deltagere.
Ønsker du andre felt eller andre endringer, så kan det tilpasses til standard timepris. Ta kontakt med oss!