1. Home
  2. REST API edoobox
  3. Angebote-Ressourcen REST API

Angebote-Ressourcen REST API

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:

NameURLGETPOSTPUTDELETEStatus
Angebotev1/offersJa 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 BeschreibungErforderlich
language String Sprache z.B. „de“
oder en, fr, es, cn, cs
 Ja
limit > startIntegerAb welcher Position ausgeben, Paging
limit > replyIntegerAnzahl Antworten, max. 100
filter > id Array Nur ein bestimmtes Angebot ausgeben

 

  • property > offer.id
  • value
    String, offer_abc_12345
 –
filter > nameArraySuchen in Angebotsnamen und -Nummern

 

  • property > offer.name
  • needle
    String, Max 20 Zeichen
filter > statusArrayAngebote mit einem bestimmten Status ausgeben

 

  • property > offer.status
  • value
    String/Integer, Komma getrennt „1,2,3“
 –
filter > edtagArrayAngebote mit bestimmten Tags ausgeben

 

  • property > offer.edtag
  • value
    String, Komma getrennt „tag1,tag2“
 –
filter > edcodeArrayWenn Angebote auf Intern, dann wird der Code verwendet

 

  • property > offer.edcode
  • value
    String, Intern-Code
 (-)
filter > startdateArrayAngebote mit einem Startdatum ab, vor oder gleich ausgeben

 

  • property > offer.startdate
  • value
    String, Format ISO_8601
    zB: 2019-05-13T09:34:09+0200
  • expression
    String, Grösser „>“ oder kleiner „<“ und gleich „=“ Zeichen erlaubt
 –
filter > enddateArrayAngebote mit einem Enddatum ab, vor oder gleich ausgeben

 

  • property > offer.enddate
  • value
    String, Format ISO_8601
    zB: 2019-05-10T09:30:00+0200
  • expression
    String, Grösser „>“ oder kleiner „<“ und gleich „=“ Zeichen erlaubt
 –
filter > displayendArrayNur Angebote ausgeben, welche angezeigt werden sollen

 

  • property > offer.displayend
  • value
    Boolean, „true“ oder „false“
Public

Wenn Zugriff über Public Key, wird dieser Parameter automatisch gesetzt

 –
filter > modulesbetweenArrayNur Angebote mit Lektionen zwischen from und to

 

  • property > offer.modulesbetween
  • from
    String, Format ISO_8601
    zB: 2019-05-10T10:20:00+0200
  • to
    String, Format ISO_8601
    zB: 2019-05-13T09:30:00+0200
 –
filter > categoryArrayAngebote einer bestimmten Kategorie

 

  • property > offer.category
  • value
    String, category_abc_12345
 –
order > startdateArraySortieren nach Startdatum

 

  • property > offer.startdate
  • value
    String, „ASC“ oder „DESC“
 –
order > idArraySortieren nach edoobox ID

 

  • property > offer.id
  • value
    String, „ASC“ oder „DESC“
 –
order > statusArraySortieren nach dem Angebots-Status

 

  • property > offer.status
  • value
    String, „ASC“ oder „DESC“
 –
order > hierarchyArraySortieren nach der Anordnung wie im edoobox Admin (Backend)

 

  • property > offer.hierarchy
  • value
    String, „ASC“ oder „DESC“
 –

Rückgabewerte

FeldArtBeschreibung Objekt
idStringedoobox ID 
nameStringAngebot Name 
numberStringAngebot Nummer 
shortdescriptionStringKurzbeschreibung 150 Zeichen 
user_maximumIntegerMaximale Anzahl Teilnehmer 
user_minimalIntegerMinimale Anzahl Teilnehmer 
start_dateStringStartdatum im Format ISO_8601 
end_dateStringEnddatum im Format ISO_8601 
deadlineStringAnmeldeschluss im Format ISO_8601 
imageStringURL zum Angebots-Bild oder FALSE 
place_idStringedoobox ID vom OrtOrt
category_idStringedoobox ID der KategorieKategorie
statusIntegerStatus vom Angebot 
waiting_listBooleanWarteliste für dieses Angebot aktiv 
offer_details_urlStringURL zum Angebot ohne Konto-Kürzel
URL-Kodierung nach RFC 3986
 
booking_start_urlStringURL zum erstellen einer neue Buchung 

GET Rückgabewerte erweitern

Werden diese Parameter bei einer GET Anfrage übergeben, werden zusätzliche Werte zurückgegeben.

FeldArtBeschreibung Objekt
pricecategoriesArrayAlle Preiskategorien in diesem Angebot

 

 Preiskategorie
usersArrayAngebots Teilnehmer

 

Public

Wenn Zugriff über Public Key, wird dieser Parameter automatisch deaktiviert

Teilnehmer
usercountIntegerAnzahl Teilnehmer, mit oder ohne Wartelistenteilnehmer

 

  • property > offer.usercount
  • value
    Boolean, „true“ oder „false“
 
descriptionStringBeschreibung 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:

Updated on 24. Juli 2019

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support