Zum Inhalt springen

Offene Schnittstelle

Unterkünfte

Die Lieferadresse einer Buchung kommt immer aus dieser Liste. Ein Gast tippt keine Adresse frei ein, sonst fährt der Fahrer an eine Stelle, die es nicht gibt. Ein Eintrag mit isDepot: true steht für die Abholung im Shop.

GET/api/ext/v1/accommodations

Recht day.viewErfolg 200

In der Abfrage

ParameterTypBedeutung
qstringSucht in Name, Ort und Straße.max. 120 Zeichen
limitintegerHöchstzahl der Einträge.1 bis 500 · Vorgabe 100
includeInactivebooleantrue zeigt auch stillgelegte Unterkünfte.Vorgabe false
Felder der Antwort
FeldTypBedeutung
accommodationsobject[]Die Unterkünfte, die häufigsten zuerst.
accommodations[].idintegerab -9007199254740991
accommodations[].namestringName der Unterkunft.
accommodations[].streetstringStraße und Hausnummer.
accommodations[].zipstringPostleitzahl.
accommodations[].citystringOrt.
accommodations[].countrystringLand, ISO 3166-1 alpha-2.
accommodations[].districtstring,nullOrtsteil.
accommodations[].latnumber,nullBreitengrad. Aus den Koordinaten rechnet der Server Lieferzone und Tour.
accommodations[].lngnumber,nullLängengrad.
accommodations[].placeIdstring,nullKennung des Ortes bei Google Places. Schützt vor Dubletten: eine vergebene Kennung führt zu 409.
accommodations[].contactNamestring,nullAnsprechperson im Haus.
accommodations[].contactPhonestring,nullTelefonnummer der Ansprechperson.
accommodations[].driverNotestring,nullHinweis für den Fahrer. Steht auf dem Tagesauftrag und nie in einer öffentlichen Liste.
accommodations[].isDepotbooleantrue für den Eintrag „Abholung im Shop“.
accommodations[].activebooleanfalse für stillgelegte Unterkünfte.
accommodations[].bookingCountintegerAnzahl der Buchungen in diesem Haus.ab -9007199254740991
Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/accommodations?q=Dorfstra%C3%9Fe&limit=10" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"accommodations": [
{
"id": 6,
"name": "Gasthof Talblick",
"street": "Dorfstraße 30",
"zip": "5999",
"city": "Bergdorf",
"country": "AT",
"district": "Unterdorf",
"lat": 47.2488,
"lng": 13.2052,
"placeId": null,
"contactName": null,
"contactPhone": null,
"driverNote": null,
"isDepot": false,
"active": true,
"bookingCount": 0
},
{
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"country": "AT",
"district": "Oberdorf",
"lat": 47.2533,
"lng": 13.2071,
"placeId": "ChIJalpenhofBergdorf0001",
"contactName": "Rezeption",
"contactPhone": "+43 000 000010",
"driverNote": "Skiraum im Untergeschoss, Zugang über die Garage.",
"isDepot": false,
"active": true,
"bookingCount": 0
}
]
}

q sucht in Name, Ort und Straße. Die Häuser mit den meisten Buchungen stehen vorn.

GET/api/ext/v1/accommodations/{id}

Recht day.viewErfolg 200

Im Pfad

ParameterTypBedeutung
idstringDie Nummer der Unterkunft.
Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/accommodations/2" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"country": "AT",
"district": "Oberdorf",
"lat": 47.2533,
"lng": 13.2071,
"placeId": "ChIJalpenhofBergdorf0001",
"contactName": "Rezeption",
"contactPhone": "+43 000 000010",
"driverNote": "Skiraum im Untergeschoss, Zugang über die Garage.",
"isDepot": false,
"active": true,
"bookingCount": 0
}

POST/api/ext/v1/accommodations

Recht accommodation.editErfolg 201

Ist placeId gesetzt und schon vergeben, antwortet der Server mit 409 und nennt den vorhandenen Eintrag. Dieselbe Stelle zweimal anzulegen ist der häufigste Weg zu einer Dublette.

Im Rumpf

FeldTypBedeutung
namePflichtstringName der Unterkunft.mind. 1 Zeichen · max. 200 Zeichen
streetstringStraße und Hausnummer.max. 200 Zeichen · Vorgabe ``
zipstringPostleitzahl.max. 20 Zeichen · Vorgabe ``
citystringOrt.max. 120 Zeichen · Vorgabe ``
countrystringLand, ISO 3166-1 alpha-2.genau 2 Zeichen · Vorgabe AT
districtstring | nullOrtsteil.max. 120 Zeichen
latnumber | nullBreitengrad. Aus den Koordinaten rechnet der Server Lieferzone und Tour.-90 bis 90
lngnumber | nullLängengrad.-180 bis 180
placeIdstring | nullKennung des Ortes bei Google Places. Schützt vor Dubletten: eine vergebene Kennung führt zu 409.max. 200 Zeichen
contactNamestring | nullAnsprechperson im Haus.max. 120 Zeichen
contactPhonestring | nullTelefonnummer der Ansprechperson.max. 60 Zeichen
driverNotestring | nullHinweis für den Fahrer. Steht auf dem Tagesauftrag und nie in einer öffentlichen Liste.max. 500 Zeichen
isDepotbooleantrue für den Eintrag „Abholung im Shop“.Vorgabe false
Terminal-Fenster
curl -X POST "https://skirent.sumware.at/api/ext/v1/accommodations" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"country": "AT",
"district": "Oberdorf",
"lat": 47.2533,
"lng": 13.2071,
"placeId": "ChIJalpenhofBergdorf0001",
"contactName": "Rezeption",
"contactPhone": "+43 000 000010",
"driverNote": "Skiraum im Untergeschoss, Zugang über die Garage."
}'

Antwort201Created

{
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"country": "AT",
"district": "Oberdorf",
"lat": 47.2533,
"lng": 13.2071,
"placeId": "ChIJalpenhofBergdorf0001",
"contactName": "Rezeption",
"contactPhone": "+43 000 000010",
"driverNote": "Skiraum im Untergeschoss, Zugang über die Garage.",
"isDepot": false,
"active": true,
"bookingCount": 0
}

Aus lat und lng rechnet der Server die Lieferzone und die Reihenfolge der Tour. Geben Sie die Koordinaten mit, wenn Sie sie haben.

Ist placeId gesetzt und schon vergeben, antwortet der Server mit 409 und nennt den vorhandenen Eintrag. Dieselbe Stelle zweimal anzulegen ist der häufigste Weg zu einer Dublette.

Terminal-Fenster
curl -X POST "https://skirent.sumware.at/api/ext/v1/accommodations" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Alpenhof Hotel",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"placeId": "ChIJalpenhofBergdorf0001"
}'

Antwort409Conflict

{
"error": {
"code": "conflict",
"message": "\"Hotel Alpenhof\" steht schon in der Liste.",
"status": 409,
"hint": "Den vorhandenen Eintrag bearbeiten statt einen zweiten anzulegen.",
"documentation_url": "https://skirent.sumware.at/api/"
}
}

PATCH/api/ext/v1/accommodations/{id}

Recht accommodation.editErfolg 200

Im Pfad

ParameterTypBedeutung
idstringDie Nummer der Unterkunft.

Im Rumpf

FeldTypBedeutung
namestringName der Unterkunft.mind. 1 Zeichen · max. 200 Zeichen
streetstringStraße und Hausnummer.max. 200 Zeichen · Vorgabe ``
zipstringPostleitzahl.max. 20 Zeichen · Vorgabe ``
citystringOrt.max. 120 Zeichen · Vorgabe ``
countrystringLand, ISO 3166-1 alpha-2.genau 2 Zeichen · Vorgabe AT
districtstring | nullOrtsteil.max. 120 Zeichen
latnumber | nullBreitengrad. Aus den Koordinaten rechnet der Server Lieferzone und Tour.-90 bis 90
lngnumber | nullLängengrad.-180 bis 180
placeIdstring | nullKennung des Ortes bei Google Places. Schützt vor Dubletten: eine vergebene Kennung führt zu 409.max. 200 Zeichen
contactNamestring | nullAnsprechperson im Haus.max. 120 Zeichen
contactPhonestring | nullTelefonnummer der Ansprechperson.max. 60 Zeichen
driverNotestring | nullHinweis für den Fahrer. Steht auf dem Tagesauftrag und nie in einer öffentlichen Liste.max. 500 Zeichen
isDepotbooleantrue für den Eintrag „Abholung im Shop“.Vorgabe false
activebooleanfalse für stillgelegte Unterkünfte.
Terminal-Fenster
curl -X PATCH "https://skirent.sumware.at/api/ext/v1/accommodations/2" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"contactName": "Rezeption, Frau Huber",
"driverNote": "Skiraum im Untergeschoss, Zugang über die Garage. Schlüssel an der Rezeption."
}'

Antwort200OK

{
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf",
"country": "AT",
"district": "Oberdorf",
"lat": 47.2533,
"lng": 13.2071,
"placeId": "ChIJalpenhofBergdorf0001",
"contactName": "Rezeption, Frau Huber",
"contactPhone": "+43 000 000010",
"driverNote": "Skiraum im Untergeschoss, Zugang über die Garage. Schlüssel an der Rezeption.",
"isDepot": false,
"active": true,
"bookingCount": 0
}

Mit active: false legen Sie ein Haus still, mit active: true kommt es zurück. Buchungen behalten die Adresse, die beim Buchen galt.

DELETE/api/ext/v1/accommodations/{id}

Recht accommodation.editErfolg 200

Hängen Buchungen daran, wird sie stillgelegt statt gelöscht (deactivated). Sonst verlöre die Auswertung "welches Haus bringt wieviel" still ihre Zuordnung.

Im Pfad

ParameterTypBedeutung
idstringDie Nummer der Unterkunft.
Felder der Antwort
FeldTypBedeutung
statusstringdeleted: gelöscht. deactivated: stillgelegt, weil Buchungen daran hängen.Erlaubt: deactivated, deleted

Ein Haus ohne Buchungen wird gelöscht:

Terminal-Fenster
curl -X DELETE "https://skirent.sumware.at/api/ext/v1/accommodations/6" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"status": "deleted"
}

Hängen Buchungen daran, wird es stillgelegt statt gelöscht. Sonst verlöre die Auswertung, welches Haus wie viel bringt, ihre Zuordnung.

Antwort200OK

{
"status": "deactivated",
"bookings": 1
}