Zum Inhalt springen

Offene Schnittstelle

Kurse

Ein Skiverleih auf Ski4me vermittelt Kurse einer Skischule: der Gast bucht Ausrüstung und Kurs in einem Zug. Die Schule muss davon erfahren, sonst steht am Kurstag ein Gast am Treffpunkt, den niemand erwartet. Diese beiden Endpunkte sind der Weg, auf dem die Schule selbst nachsieht.

Je gebuchtem Kurs einen Eintrag mit dem, was ein Kursleiter braucht: Kurs, Termin, Beginn, Treffpunkt, Sprache, Niveau, Teilnehmer mit Namen und Alter, eine Kontaktperson.

Was nicht darin steht:

  • nichts aus dem Verleih derselben Buchung: keine Körpergröße, kein Gewicht, keine Schuhgröße, kein Fahrertyp
  • keine Unterkunft und keine Zimmernummer
  • keine Zahlungsdaten und kein Prüfcode
  • nicht die Provision des Betriebs

Das Recht course.view gibt genau diese Einträge heraus und keine Buchung ohne Kurs. Deshalb ist es ein eigenes Recht und nicht booking.view.

GET/api/ext/v1/courses

Recht course.viewErfolg 200

Je Kursposten ein Eintrag mit Termin, Treffpunkt, Sprache, Niveau, Teilnehmern mit Alter und einer Kontaktperson. Nichts aus dem Verleih, keine Zahlungsdaten und nicht die Provision. since nimmt den Wert asOf der vorigen Antwort und liefert nur, was sich seither geändert hat. Was hier abgeholt wird, gilt im Portal als gemeldet.

In der Abfrage

ParameterTypBedeutung
fromstringErster Kurstag ab diesem Tag.JJJJ-MM-TT
tostringErster Kurstag bis zu diesem Tag.JJJJ-MM-TT
statusstringNur Kurse in diesem Zustand.Erlaubt: booked, changed, cancelled
sincestringNur, was sich seit diesem Zeitpunkt geändert hat. Nehmen Sie asOf der vorigen Antwort.Muster ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ · ISO 8601 mit Z
limitintegerHöchstzahl der Einträge.1 bis 1000 · Vorgabe 200
Felder der Antwort
FeldTypBedeutung
coursesobject[]Vermittelte Kurse, sortiert nach Termin.
courses[].uidstringKennung des Kurspostens. Bleibt über Buchung, Änderung und Storno dieselbe.
courses[].bookingRefstringBuchungsnummer, für Rückfragen beim Betrieb.
courses[].statusstringbooked, changed oder cancelled.Erlaubt: booked, changed, cancelled
courses[].providerstringWoher der Kurs stammt. eigen für den Katalog des Betriebs.
courses[].courseIdstringKennung des Kurses im Katalog.
courses[].courseNamestringName des Kurses.
courses[].variantIdstringKennung der gebuchten Variante (Dauer und Beginn).
courses[].datestringErster Kurstag.
courses[].daysintegerAnzahl der Kurstage.ab -9007199254740991
courses[].timeFromstring,nullBeginn als HH:MM.
courses[].meetingPointIdstring,nullKennung des Treffpunkts.
courses[].meetingPointNamestring,nullName des Treffpunkts.
courses[].skillIdstring,nullKennung des Niveaus.
courses[].skillNamestring,nullNiveau in der Sprache des Betriebs.
courses[].languagestringKurssprache.
courses[].personsintegerAnzahl der Teilnehmer.ab -9007199254740991
courses[].participantsobject[]Teilnehmer mit Name und Alter.
courses[].participants[].firstNamestring
courses[].participants[].lastNamestring
courses[].participants[].ageinteger | nullab -9007199254740991
courses[].contactobject | nullKontaktperson der Buchung. null nach dem Löschlauf.
courses[].contact.namestringName der Unterkunft.
courses[].contact.emailstring
courses[].contact.phonestring
courses[].amountCentsintegerKurspreis in Cent, den der Gast bezahlt hat.ab -9007199254740991
courses[].currencystringWährung nach ISO 4217.
courses[].bookedAtstringZeitpunkt der Buchung.
courses[].updatedAtstringLetzte Änderung am Kursposten.
courses[].reportedAtstring,nullSeit wann der Kurs als gemeldet gilt. Ein Abruf über diese Schnittstelle setzt den Zeitpunkt.
asOfstringZeitpunkt dieser Abfrage. Als since der nächsten Abfrage mitgeben.
Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/courses?from=2026-12-27&to=2027-01-02" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

Antwort anzeigen 75 Zeilen
{
"courses": [
{
"uid": "01a1db4a-b5a4-7331-84c1-5c71a25feb38",
"bookingRef": "SB-261114-WWNP",
"status": "booked",
"provider": "eigen",
"courseId": "kinder-3t",
"courseName": "Kinderkurs, 3 Tage",
"variantId": "1",
"date": "2026-12-28",
"days": 3,
"timeFrom": "10:00",
"meetingPointId": "schule",
"meetingPointName": "Treffpunkt der Skischule",
"skillId": "beginner",
"skillName": "Anfänger",
"language": "de",
"persons": 1,
"participants": [
{
"firstName": "Leon",
"lastName": "Berger",
"age": 11
}
],
"contact": {
"name": "Martin Berger",
"email": "martin.berger@example.org",
"phone": "+49 000 0000002"
},
"amountCents": 19500,
"currency": "EUR",
"bookedAt": "2026-11-14T18:22:44.270Z",
"updatedAt": "2026-11-14T18:21:08.900Z",
"reportedAt": "2026-11-14T18:23:26.640Z"
},
{
"uid": "01a1d0a1-941e-7285-840a-b1ba0e382d8d",
"bookingRef": "SB-261112-WDZH",
"status": "cancelled",
"provider": "eigen",
"courseId": "privat-1h",
"courseName": "Private ski lesson",
"variantId": "3",
"date": "2026-12-29",
"days": 1,
"timeFrom": "13:30",
"meetingPointId": "schule",
"meetingPointName": "the ski school meeting point",
"skillId": "advanced",
"skillName": "Advanced",
"language": "en",
"persons": 1,
"participants": [
{
"firstName": "Petra",
"lastName": "Novak",
"age": 36
}
],
"contact": {
"name": "Petra Novak",
"email": "petra.novak@example.org",
"phone": "+43 000 000004"
},
"amountCents": 7900,
"currency": "EUR",
"bookedAt": "2026-11-12T16:41:47.944Z",
"updatedAt": "2026-11-20T08:14:55.400Z",
"reportedAt": "2026-11-14T18:23:26.640Z"
}
],
"asOf": "2026-12-20T06:00:04.782Z"
}

Die Liste nennt Kurse aus bezahlten und bestätigten Buchungen, dazu solche, die später storniert wurden. from und to beziehen sich auf den ersten Kurstag.

Jede Antwort trägt asOf, den Zeitpunkt der Abfrage. Als since der nächsten Abfrage liefert er nur, was sich seither geändert hat. Ist nichts geschehen, ist die Liste leer:

Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/courses?since=2026-12-20T06%3A00%3A04.782Z" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"courses": [],
"asOf": "2026-12-20T06:00:07.522Z"
}

asOf wird vor dem Lesen genommen. Was während einer Abfrage geändert wird, kommt beim nächsten Mal noch einmal und geht nicht verloren. Rechnen Sie deshalb damit, einen Eintrag zweimal zu sehen, und erkennen Sie ihn an uid.

Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/courses?status=cancelled" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"courses": [
{
"uid": "01a1d0a1-941e-7285-840a-b1ba0e382d8d",
"bookingRef": "SB-261112-WDZH",
"status": "cancelled",
"provider": "eigen",
"courseId": "privat-1h",
"courseName": "Private ski lesson",
"variantId": "3",
"date": "2026-12-29",
"days": 1,
"timeFrom": "13:30",
"meetingPointId": "schule",
"meetingPointName": "the ski school meeting point",
"skillId": "advanced",
"skillName": "Advanced",
"language": "en",
"persons": 1,
"participants": [
{
"firstName": "Petra",
"lastName": "Novak",
"age": 36
}
],
"contact": {
"name": "Petra Novak",
"email": "petra.novak@example.org",
"phone": "+43 000 000004"
},
"amountCents": 7900,
"currency": "EUR",
"bookedAt": "2026-11-12T16:41:47.944Z",
"updatedAt": "2026-11-20T08:14:55.400Z",
"reportedAt": "2026-11-14T18:23:26.640Z"
}
],
"asOf": "2026-12-20T06:00:08.892Z"
}

GET/api/ext/v1/courses/{uid}

Recht course.viewErfolg 200

uid bleibt über Buchung, Änderung und Storno dieselbe.

Im Pfad

ParameterTypBedeutung
uidstringDie Kennung des Kurspostens aus uid.
Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/courses/01a1db4a-b5a4-7331-84c1-5c71a25feb38" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"uid": "01a1db4a-b5a4-7331-84c1-5c71a25feb38",
"bookingRef": "SB-261114-WWNP",
"status": "booked",
"provider": "eigen",
"courseId": "kinder-3t",
"courseName": "Kinderkurs, 3 Tage",
"variantId": "1",
"date": "2026-12-28",
"days": 3,
"timeFrom": "10:00",
"meetingPointId": "schule",
"meetingPointName": "Treffpunkt der Skischule",
"skillId": "beginner",
"skillName": "Anfänger",
"language": "de",
"persons": 1,
"participants": [
{
"firstName": "Leon",
"lastName": "Berger",
"age": 11
}
],
"contact": {
"name": "Martin Berger",
"email": "martin.berger@example.org",
"phone": "+49 000 0000002"
},
"amountCents": 19500,
"currency": "EUR",
"bookedAt": "2026-11-14T18:22:44.270Z",
"updatedAt": "2026-11-14T18:21:08.900Z",
"reportedAt": "2026-11-14T18:23:26.640Z"
}

uid bleibt über Buchung, Änderung und Storno dieselbe. Mit ihr führen Sie einen Kurs in Ihrem eigenen System.

Was die Schule über diese Endpunkte abholt, gilt im Portal des Betriebs als gemeldet: reportedAt wird gesetzt, und der Hinweis „noch nicht gemeldet“ verschwindet. Für stornierte Kurse gilt das nicht.

Wer nicht abfragen will, bekommt dieselben Angaben als Meldung an eine eigene Adresse. Der Rumpf ist derselbe.

status Bedeutung
booked Der Kurs ist gebucht und bezahlt.
changed Termin, Variante, Treffpunkt, Sprache oder Teilnehmerzahl haben sich geändert.
cancelled Die Buchung wurde storniert. Der Platz ist frei.

In der aktuellen Fassung entstehen booked und cancelled. changed ist vorgesehen; ein Programm, das den Wert heute schon kennt, braucht später nichts nachzuziehen.