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:

Name URL GET POST PUT DELETE Status
Preiskategorie v1/pricecategories Ja  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  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. 10
filter > id  Array  Nur eine bestimmte Preiskategorie ausgeben

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

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

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

  • property > pricecategorie.name
  • value
    String, „ASC“ oder „DESC“
 –
order > hierarchy Array Sortieren 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

Feld Art Beschreibung  Objekt
id String edoobox ID
active Boolean Ist die Kategorie aktiv
name String Preiskategorie Name
price Float Preis der Kategorie
available_places Integer Anzahl verfügbarer Plätze (Standard-Preiskategorie immer 99999, wird durch die maximale Anzahl Teilnehmer im Angebot beschränkt)
start_date String Startdatum im Format ISO_8601 wenn aktiv, sonst FALSE
end_date String Enddatum 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.

Feld Art Beschreibung  Objekt
bookings_count Integer Anzahl Buchungen für diese Preiskategorie

  • property > pricecategorie.bookings_count
  • value
    Boolean > „true“ = nur abgeschlossene Buchungen oder „false“ = mit Warteliste-Teilnehmer
temporary_count Integer Anzahl 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 18. Mai 2018

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