API - Deltagerliste
Dette er et standard API som brukes av Pindena Innsjekk appen. Det betyr at alle deltagerne som listes ut har status Påmeldt eller Bekreftet i den aktiviteten.
Det er mulig å benytte API-et for å hente ut en feed med deltagere på en aktivitet i JSON-format.
API-et kan også liste ut endrede deltagere hvis du bruker parameterne.
Forespørsel (request)
| URL | /api/v1/activities/<id>/participants Bytt ut <id> med ID til din aktivitet. |
| Parametere | updated_after, updated_before Format: Dato og tid eller bare dato, eksempel: 2020-08-14 00:00 Parameterne er valgfrie og kan brukes sammen eller hver for seg. |
| 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. |
Svar (response)
Api-et returnerer statuskode 200 og et array med deltagere i JSON-format.
Hvis minst en av parameterne updated_after eller updated_before brukes, returneres deltagere med alle statuser. Uten disse parameterne returneres bare deltagere med statusene Påmeldt eller Bekreftet.
Felt som hentes ut:
| Feltnavn (JSON) |
Feltnavn (i admin/backend) |
| RegistrationPersonStructID | Deltager-ID (løpenummer) |
| RegistrationID | Aktivitets-ID (løpenummer) |
| Active | Aktiv (0 eller 1) |
| FirstName | Fornavn |
| LastName | Etternavn |
| E-postadresse | |
| Phone | Mobilnummer |
| CompanyName | Firmanavn |
| Status | Status (registered, confirmed) |
| Paid | Betalt-status (NotPaid, Paid, Invoiced, Due, Credited) |
| Attended | Deltatt (0 eller 1) |
| Passed | Bestått (0 eller 1) |
| Count | Antall billetter |
| MessageForApp | Fra v6.6.0: Melding til innsjekker når deltagerens qr-kode skannes. Internt felt på deltager som admin kan bruke ved behov. |
| TotalPrice | Fra v6.6.0: Prisen på deltagerens påmelding, inkl. eventuelle ekstradeltagere. |
Merk:
API-et leverer et sub-sett av feltene som er tilgjengelige på en deltager.
Ønsker du andre felt eller andre endringer, så kan det tilpasses til standard timepris. Ta kontakt med oss!