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:

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 property > offer.id *value* String, offer_abc_12345	–
filter > name	Array	Suchen in Angebotsnamen und -Nummern *property* > offer.name needle String, Max 20 Zeichen	–
filter > status	Array	Angebote mit einem bestimmten Status ausgeben *property* > offer.status value String/Integer, Komma getrennt „1,2,3“	–
filter > edtag	Array	Angebote mit bestimmten Tags ausgeben *property* > offer.edtag value String, Komma getrennt „tag1,tag2“	–
filter > edcode	Array	Wenn Angebote auf Intern, dann wird der Code verwendet *property* > offer.edcode value String, Intern-Code	(-)
filter > startdate	Array	Angebote 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 > enddate	Array	Angebote 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 > displayend	Array	Nur 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 > modulesbetween	Array	Nur 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 > category	Array	Angebote einer bestimmten Kategorie *property* > offer.category value String, category_abc_12345	–
order > startdate	Array	Sortieren nach Startdatum *property* > offer.startdate value String, „ASC“ oder „DESC“	–
order > id	Array	Sortieren nach edoobox ID *property* > offer.id value String, „ASC“ oder „DESC“	–
order > status	Array	Sortieren nach dem Angebots-Status *property* > offer.status value String, „ASC“ oder „DESC“	–
order > hierarchy	Array	Sortieren nach der Anordnung wie im edoobox Admin (Backend) *property* > offer.hierarchy value String, „ASC“ oder „DESC“	–

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 *property* > offer.pricecategories value Object, Pricecategorie	Preiskategorie
users	Array	Angebots Teilnehmer *property* > offer.users value Object, User Public Wenn Zugriff über Public Key, wird dieser Parameter automatisch deaktiviert	Teilnehmer
usercount	Integer	Anzahl Teilnehmer, mit oder ohne Wartelistenteilnehmer *property* > offer.usercount value Boolean, „true“ oder „false“
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:

	<?php
	$client->get('offers', array(
	'language' => 'de',
	'filter' => array(
	array(
	'property' => 'offer.id',
	'value' => 'offer_abc_1234'
	),
	array(
	'property' => 'offer.name',
	'needle' => 'test name'
	),
	array(
	'property' => 'offer.status',
	'value' => '1,2'
	),
	array(
	'property' => 'offer.edtag',
	'value' => 'test,abc'
	),
	array(
	'property' => 'offer.edcode',
	'value' => 'test'
	),
	array(
	'property' => 'offer.startdate',
	'expression' => '>',
	'value' => '2019-05-01T09:34:09+0200'
	),
	array(
	'property' => 'offer.enddate',
	'expression' => '>',
	'value' => '2019-05-01T09:34:09+0200'
	),
	array(
	'property' => 'offer.modulesbetween',
	'from' => '2019-05-01T09:30:00+0200',
	'to' => '2019-05-10T09:30:00+0200'
	),
	array(
	'property' => 'offer.category',
	'value' => 'category_abc_12345'
	),
	array(
	'property' => 'offer.displayend',
	'value' => true
	),
	),
	'limit' => array('start' => 0,
	'reply' => 10),
	'order' => array(
	array( 'property' => 'offer.startdate',
	'value' => 'DESC'
	),
	array( 'property' => 'offer.id',
	'value' => 'DESC'
	),
	array( 'property' => 'offer.status',
	'value' => 'DESC'
	),
	array( 'property' => 'offer.hierarchy',
	'value' => 'DESC'
	)
	),
	'data' => array(
	array(
	'property' => 'offer.description',
	'value' => true
	),

	array(
	'property' => 'offer.usercount',
	'value' => true
	),

	array(
	'property' => 'offer.users',
	'value' => array(
	'filter' => array(),
	'limit' => array(),
	'order' => array()
	)
	),

	array(
	'property' => 'offer.pricecategories',
	'value' => array(
	'filter' => array(),
	'limit' => array(),
	'order' => array()
	)
	)
	)
	));

view raw get_offer_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