Buchung-Ressourcen REST API

Einführung

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

Allgemeine Information

Diese Ressource unterstützt die folgenden Operationen:

Name	URL	GET	POST	PUT	DELETE	Status
Buchungen	v1/bookings	Ja	Ja	Ja	–

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

Ressource URL

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

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 Buchung ausgeben property > booking.id *value* String, booking_abc_1234	(Ja)
filter > offer.id	Array	Nur Buchungen von einem bestimmten Angebot *property* > offer.id value String, „offer_abc_1234“	(Ja)
filter > user.id	Array	Nur Buchungen von einem bestimmten User *property* > user.id value String, „user_abc_1234“	(Ja)
filter > status	Array	Abgeschlossene Buchungen, oder Warteliste *property* > booking.status value String, „default“ „waitinglist“ „mustpay“	–
order > time	Array	Sortieren nach Buchungszeit *property* > booking.time value String, „ASC“ oder „DESC“	–

(Ja) Ist erforderlich

Es muss zwingend eine Buchungs ID, Angebots ID oder eine User ID übergeben werden

Rückgabewerte

Feld	Art	Beschreibung
id	String	edoobox ID
status	String	„default“ „waitinglist“ „mustpay“
time	String	Buchungsdatum im Format ISO_8601
offer_id	Float	Angebot ID
owner	Array	Enthält die User ID des Besitzers und die Konto Buchung mit Nummer
users	Array	Enthält die Teilnehmer in dieser Buchung und die Preiskategorie ID

GET Rückgabewerte erweitern

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

Feld	Art	Beschreibung	Objekt
users	Array	Teilnehmer in der Buchung, Sammelteilnehmer *property* > offer.users value Object, User	Teilnehmer

Feld

Art

Beschreibung

Objekt

users

Array

Teilnehmer in der Buchung, Sammelteilnehmer

property > offer.users
value
Object, User

Teilnehmer

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:

	<?php

	$ApiData = $client->get('bookings', array(
	'language' => 'de',
	'filter' => array(
	array(
	'property' => 'booking.id',
	'value' => 'booking_abc_1234'
	),
	array(
	'property' => 'offer.id',
	'value' => 'offer_abc_1234'
	),
	array(
	'property' => 'user.id',
	'value' => 'user_abc_1234'
	),
	array(
	'property' => 'booking.status',
	'value' => 'default'
	)
	),
	'order' => array(
	array( 'property' => 'booking.time',
	'value' => 'DESC'
	)
	),
	'data' => array(
	array(
	'property' => 'booking.users',
	'value' => array(
	'filter' => array(),
	'limit' => array(),
	'order' => array()
	)
	)
	)
	));

view raw get_booking_sample1.php hosted with ❤ by GitHub

Updated on 5. März 2020

Was this article helpful?

Yes No

Die Lösung nicht gefunden?

Dann erstellen Sie eine Support-Anfrage.

Support Ticket