Aanwezige gasten

De enige resource van de hotspotintegratie. Geeft kamer, identiteit en in- en uitcheckgegevens terug voor elke gast die op dit moment in het hotel verblijft (ingecheckt en nog niet uitgecheckt). De hotspotsoftware haalt deze lijst met vaste tussenpozen op en opent of sluit wifi-accounts op basis daarvan; de stappen staan in de handleiding Gastverificatieflow.

POST/public/json/customer/inhotelLijst met aanwezige gasten

Object#

Velden

uniqueinteger
ID van het verblijfsrecord, uniek per gast en reservering. Gebruik dit als gebruikers- of sessiesleutel aan de hotspotkant.
rezervasyon_idinteger
Reserverings-ID. Gasten die een kamer delen, hebben dezelfde waarde.
inHotelinteger
1 = de gast is aanwezig in het hotel. Altijd 1, omdat het endpoint alleen aanwezige gasten teruggeeft.
firstNamestring
Voornaam. Meestal in hoofdletters, zoals gelezen van het identiteitsbewijs; meerdere voornamen worden gescheiden door een spatie.
lastNamestring
Achternaam. Meestal in hoofdletters.
identityNumberstring | null
Turks nationaal identiteitsnummer of paspoortnummer, zoals vermeld op het document. Kan leeg zijn bij gasten die zonder identiteitsgegevens zijn geregistreerd.
birthDatestring | null
Geboortedatum, DD.MM.YYYY. Kan leeg zijn.
roomIDinteger
De HMS-ID van de kamer.
roomNamestring
Kamernaam of -nummer zoals de gast die op de deur en de sleutelkaart ziet. Vraag hierom als “kamernummer” op het portal.
checkininteger
Incheckmoment van de gast als Unix-timestamp (seconden).
checkoutinteger
Geplande uitcheckdatum als Unix-timestamp aan het begin van de dag (00:00 UTC); bevat geen tijdstip. Tel de uitchecktijd van het hotel (meestal 12:00) erbij op voor het einde van de sessie.
checkout2integer | null
Werkelijk uitcheckmoment. null voor aanwezige gasten; een gast die uitcheckt, verdwijnt sowieso uit de lijst.
mikrotikSifrelemeinteger
De Mikrotik-versleutelingsinstelling in HMS van het gebouw waarin de kamer ligt: 0 kamernaam (het wifi-wachtwoord is het kamernummer), 1 geen wachtwoord. Pas hetzelfde beleid toe op je eigen portal.
01
Voorbeeldobject
{
    "mikrotikSifreleme": 0,
    "unique": 58211,
    "inHotel": 1,
    "identityNumber": "11111111110",
    "firstName": "AYŞE",
    "lastName": "DEMİR",
    "birthDate": "14.03.1985",
    "roomID": 4,
    "roomName": "104",
    "checkin": 1788863400,
    "checkout": 1788998400,
    "checkout2": null,
    "rezervasyon_id": 282799
}

Lijst met aanwezige gasten#

POST/public/json/customer/inhotel

Authenticatie: ApiKey-header

Geeft de volledige lijst met aanwezige gasten terug. Er zijn geen filterparameters en er is geen body. Een gast staat in de lijst als de reservering actief is, is ingecheckt en nog niet is uitgecheckt, en de gast is gemarkeerd als “in het hotel”. Elke gast van dezelfde reservering is een apart record.

Het antwoord is niet gepagineerd; grote hotels kunnen enkele honderden records teruggeven. Cache de lijst en vernieuw die met het aanbevolen interval.

Headers

ApiKeystringverplicht
Eigen API-sleutel (Custom API), aangemaakt in het HMS-beheerpaneel. Gebonden aan één hotel; dat hotel bepaalt welke gasten worden getoond.
HotelCodeinteger
De HMS-ID van het hotel. Wordt niet gebruikt voor validatie, omdat de server het hotel uit de sleutel afleidt; aanbevolen voor logging en compatibiliteit.

Antwoord

200 success: 1 en de array otelde. Is er niemand aanwezig, dan is de array leeg; dat is geen fout.

successinteger
1 geslaagd, 0 mislukt. Een getal, geen boolean zoals bij Online Booking.
otelde[]object[]
Gastrecords. Zie de sectie Object hierboven voor de velden.

Foutantwoorden

  • 401 ApiKey-header ontbreekt, is leeg of is niet bekend in HMS (mogelijk verwijderd). Body: {"success": 0}.
  • 405 Het verzoek gebruikte een andere methode dan POST (bijvoorbeeld GET vanuit de adresbalk van een browser).
Verzoek
curl -X POST "https://test.hms.gen.tr/public/json/customer/inhotel" \
  -H "ApiKey: $HMS_API_KEY" \
  -H "HotelCode: 1000"
Antwoord · 200
{
    "success": 1,
    "otelde": [
        {
            "mikrotikSifreleme": 0,
            "unique": 58211,
            "inHotel": 1,
            "identityNumber": "11111111110",
            "firstName": "AYŞE",
            "lastName": "DEMİR",
            "birthDate": "14.03.1985",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58212,
            "inHotel": 1,
            "identityNumber": "22222222220",
            "firstName": "MEHMET",
            "lastName": "DEMİR",
            "birthDate": "02.11.1982",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58197,
            "inHotel": 1,
            "identityNumber": "U01234567",
            "firstName": "JULIA",
            "lastName": "WAGNER",
            "birthDate": "27.06.1990",
            "roomID": 12,
            "roomName": "205",
            "checkin": 1788782700,
            "checkout": 1789084800,
            "checkout2": null,
            "rezervasyon_id": 282803
        }
    ]
}
Antwoord · 200 (geen gasten aanwezig)
{
    "success": 1,
    "otelde": []
}
Antwoord · 401 (ongeldige sleutel)
{
    "success": 0
}
Laatst bijgewerkt: 21 september 2026Fout gevonden? Laat het ons weten