Einführung
In diesem Teil erhalten Sie Informationen, wie auf sämtliche Angebote (Kurse, Seminare, Events etc.) zugegriffen werden kann.
Allgemeine Information
Diese Ressource unterstützt die folgenden Operationen:
| Name | URL | GET | POST | PUT | DELETE | Status |
|---|---|---|---|---|---|---|
| Angebote | v1/offers | Ja | Ja | – | – |
Wenn Sie auf diese Ressource zugreifen möchten, verwenden Sie folgende URL:
Ressource URL
https://api.edoobox.com/v1/offers
Definitionen
GET Parameter für Abfrage
Sämtliche Parameter, welche bei einer GET Anfrage enthalten sein können oder erforderlich sind:
| Parameter | Art | Beschreibung | Erforderlich |
|---|---|---|---|
| language | String | Sprache z.B. „de“ oder en, fr, es, cn, cs | Ja |
| limit > start | Integer | Ab welcher Position ausgeben, Paging | – |
| limit > reply | Integer | Anzahl Antworten, max. 100 | – |
| filter > id | Array | Nur ein bestimmtes Angebot ausgeben
| – |
| filter > name | Array | Suchen in Angebotsnamen und -Nummern
| – |
| filter > status | Array | Angebote mit einem bestimmten Status ausgeben
| – |
| filter > edtag | Array | Angebote mit bestimmten Tags ausgeben
| – |
| filter > edcode | Array | Wenn Angebote auf Intern, dann wird der Code verwendet
| (-) |
| filter > startdate | Array | Angebote mit einem Startdatum ab, vor oder gleich ausgeben
| – |
| filter > enddate | Array | Angebote mit einem Enddatum ab, vor oder gleich ausgeben
| – |
| filter > displayend | Array | Nur Angebote ausgeben, welche angezeigt werden sollen
Public Wenn Zugriff über Public Key, wird dieser Parameter automatisch gesetzt | – |
| filter > modulesbetween | Array | Nur Angebote mit Lektionen zwischen from und to
| – |
| filter > category | Array | Angebote einer bestimmten Kategorie
| – |
| order > startdate | Array | Sortieren nach Startdatum
| – |
| order > id | Array | Sortieren nach edoobox ID
| – |
| order > status | Array | Sortieren nach dem Angebots-Status
| – |
| order > hierarchy | Array | Sortieren nach der Anordnung wie im edoobox Admin (Backend)
| – |
Rückgabewerte
| Feld | Art | Beschreibung | Objekt |
|---|---|---|---|
| id | String | edoobox ID | |
| name | String | Angebot Name | |
| number | String | Angebot Nummer | |
| shortdescription | String | Kurzbeschreibung 150 Zeichen | |
| user_maximum | Integer | Maximale Anzahl Teilnehmer | |
| user_minimal | Integer | Minimale Anzahl Teilnehmer | |
| start_date | String | Startdatum im Format ISO_8601 | |
| end_date | String | Enddatum im Format ISO_8601 | |
| deadline | String | Anmeldeschluss im Format ISO_8601 | |
| image | String | URL zum Angebots-Bild oder FALSE | |
| place_id | String | edoobox ID vom Ort | Ort |
| category_id | String | edoobox ID der Kategorie | Kategorie |
| status | Integer | Status vom Angebot | |
| waiting_list | Boolean | Warteliste für dieses Angebot aktiv | |
| offer_details_url | String | URL zum Angebot ohne Konto-Kürzel URL-Kodierung nach RFC 3986 | |
| booking_start_url | String | URL zum erstellen einer neue Buchung |
GET Rückgabewerte erweitern
Werden diese Parameter bei einer GET Anfrage übergeben, werden zusätzliche Werte zurückgegeben.
| Feld | Art | Beschreibung | Objekt |
|---|---|---|---|
| pricecategories | Array | Alle Preiskategorien in diesem Angebot
| Preiskategorie |
| users | Array | Angebots Teilnehmer
Public Wenn Zugriff über Public Key, wird dieser Parameter automatisch deaktiviert | Teilnehmer |
| usercount | Integer | Anzahl Teilnehmer, mit oder ohne Wartelistenteilnehmer
| |
| description | String | Beschreibung von diesem Angebot |
GET Beispiel
Dazu ein Beispiel, wie diese Parameter im GET-Request übergeben werden. Dieses Beispiel enthält alle Parameter, somit müssen erst die unnötigen Parameter entfernt werden:
