Zum Hauptinhalt springen

Verfügbarkeiten

Beschreibung

Dieser Endpunkt liefert die Pooler mit Verfügbarkeiten für einen bestimmten Zeitraum.

Pfad

GET /get-availabilities

Parameter

Dieser Endpunkt akzeptiert die folgenden Abfrageparameter:

ParameterBeschreibungTypErforderlichStandartwertMögliche Werte
startDateStartdatum, valider string für new Date()StringNeinHeute'2023-01-01'
endDateEnddatum, valider string für new Date()StringNeinHeute + 3 Monate'2023-01-31'

Antwort

Dieser Endpunkt liefert die folgende Antwort als JSON:

Felder

FeldBeschreibung
userId: stringID des Poolers
firstName: stringVorname des Poolers
lastName: stringNachname des Poolers
email: stringE-Mail des Poolers
availabilities: Availability[]Verfügbarkeiten des Poolers

Availability

FeldBeschreibung
date: numberDatum der Verfügbarkeit als UNIX Timestamp
dateFormatted: stringDatum der Verfügbarkeit (YYYY-MM-DD HH:mm:ss)
shifts: ShiftsVerfügbarkeiten des Poolers
note?: stringNotiz zur Verfügbarkeit

Shifts

FeldBeschreibung
0?: stringVerfügbarkeit des Poolers für die Frühschicht
1?: stringVerfügbarkeit des Poolers für die Mittelschicht
2?: stringVerfügbarkeit des Poolers für die Spätschicht
3?: stringVerfügbarkeit des Poolers für die Nachtschicht

Beispiel

[
{
"poolerId": "pooler1",
"poolerFirstName": "Hans",
"poolerLastName": "Müller",
"poolerEmail": "h.mueller@in-pool.ch",
"availabilities": [
{
"date": "1675126800",
"dateFormatted": "2023-01-31 02:00:00",
"shifts": {
"0": "AVAILABLE",
"1": "AVAILABLE",
"2": "WORKING",
"3": "UNAVAILABLE"
},
"note": "Ich kann nur bis 16:00 arbeiten"
}
]
}
]