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

Pricecategories-Ressourcen REST API

Einführung

In diesem Teil erhalten Sie Informationen, wie auf sämtliche Preiskategorien zugegriffen werden kann.

Allgemeine Information

Diese Ressource unterstützt die folgenden Operationen:

NameURLGETPOSTPUTDELETEStatus
Preiskategoriev1/pricecategoriesJa Ja Ja –

Wenn Sie auf diese Ressource zugreifen möchten, verwenden Sie folgende URL:

Ressource URL

https://api.edoobox.com/v1/pricecategories

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. 10
filter > id Array Nur eine bestimmte Preiskategorie ausgeben

  • property > pricecategorie.id
  • value
    String, pricecategorie_abc_1234
 (Ja)
filter > offer.idArrayNur Preiskategorien von einem bestimmten Angebot

  • property > offer.id
  • value
    String, „offer_abc_1234“
(Ja)
filter > status_activeArrayNur aktive Preiskategorien

  • property > pricecategorie.status_active
  • value
    Boolean, „true“ oder „false“
order > nameArraySortieren nach dem Preiskategorie Namen

  • property > pricecategorie.name
  • value
    String, „ASC“ oder „DESC“
 –
order > hierarchyArraySortieren nach der Hierarchie im edoobox Admin

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

(Ja) ist erforderlich

Es muss zwingend eine Preiskategorie ID oder eine Angebots ID übergeben werden

Rückgabewerte

FeldArtBeschreibung Objekt
idStringedoobox ID
activeBooleanIst die Kategorie aktiv
nameStringPreiskategorie Name
priceFloatPreis der Kategorie
available_placesIntegerAnzahl verfügbarer Plätze (Standard-Preiskategorie immer 99999, wird durch die maximale Anzahl Teilnehmer im Angebot beschränkt)
start_dateStringStartdatum im Format ISO_8601 wenn aktiv, sonst FALSE
end_dateStringEnddatum im Format ISO_8601 wenn aktiv, sonst FALSE

GET Rückgabewerte erweitern

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

FeldArtBeschreibung Objekt
bookings_countIntegerAnzahl Buchungen für diese Preiskategorie

  • property > pricecategorie.bookings_count
  • value
    Boolean > „true“ = nur abgeschlossene Buchungen oder „false“ = mit Warteliste-Teilnehmer
temporary_countIntegerAnzahl Buchungen, welche temporär (bei deaktiviertem Countdown) 30 Minuten blockiert sind

  • property > pricecategorie.temporary_count
  • value
    not defined

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 23. August 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