POST api/public/kiosk/devices/heartbeat

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LocationId	integer	None.
AppVersion	string	None.
HubVersion	string	None.
OsVersion	string	None.
UptimeSeconds	integer	None.
BadgesEnabled	boolean	None.
EnvironmentName	string	None.
LogDays	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "LocationId": 1,
  "AppVersion": "sample string 1",
  "HubVersion": "sample string 2",
  "OsVersion": "sample string 3",
  "UptimeSeconds": 1,
  "BadgesEnabled": true,
  "EnvironmentName": "sample string 4",
  "LogDays": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<KioskHeartbeatRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bluedock.Booking.Rest.Models.Kiosk">
  <AppVersion>sample string 1</AppVersion>
  <BadgesEnabled>true</BadgesEnabled>
  <EnvironmentName>sample string 4</EnvironmentName>
  <HubVersion>sample string 2</HubVersion>
  <LocationId>1</LocationId>
  <LogDays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LogDays>
  <OsVersion>sample string 3</OsVersion>
  <UptimeSeconds>1</UptimeSeconds>
</KioskHeartbeatRequestDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'KioskHeartbeatRequestDTO'.

Response Information

Resource Description

KioskHeartbeatResponseDTO

Name	Type	Additional information
ServerTimeUtc	date	None.
PendingLogRequest	KioskPendingLogRequestDTO	None.
PendingCommand	KioskPendingCommandDTO	None.
BadgeSweeper	KioskBadgeSweeperDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "ServerTimeUtc": "2026-10-27T08:47:35.8451078+00:00",
  "PendingLogRequest": {
    "Id": 1,
    "DaysBack": 64,
    "CorrelationId": "174b7d4c-f953-43cb-ad6e-71ae2a90c2ae",
    "RequestedAtUtc": "2026-10-27T08:47:35.8451078+00:00"
  },
  "PendingCommand": {
    "Id": 1,
    "Command": "sample string 2",
    "PayloadJson": "sample string 3",
    "RequestedAtUtc": "2026-10-27T08:47:35.8451078+00:00",
    "CorrelationId": "0aeac195-9fb8-42df-b402-571455f5250d",
    "AcknowledgedAtUtc": "2026-10-27T08:47:35.8451078+00:00",
    "AttemptCount": 6
  },
  "BadgeSweeper": {
    "DeviceId": "sample string 1",
    "DeviceName": "sample string 2",
    "LeaseUntilUtc": "2026-10-27T08:47:35.8451078+00:00",
    "IsThisDevice": true,
    "PreferredDeviceId": "sample string 4",
    "PreferredDeviceName": "sample string 5",
    "BadgesHeardCount": 1,
    "BadgesHeardAgeSeconds": 1,
    "BlindSinceUtc": "2026-10-27T08:47:35.8451078+00:00"
  }
}

application/xml, text/xml

Sample:

<KioskHeartbeatResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bluedock.Booking.Rest.Models.Kiosk">
  <BadgeSweeper>
    <BadgesHeardAgeSeconds>1</BadgesHeardAgeSeconds>
    <BadgesHeardCount>1</BadgesHeardCount>
    <BlindSinceUtc>2026-10-27T08:47:35.8451078+00:00</BlindSinceUtc>
    <DeviceId>sample string 1</DeviceId>
    <DeviceName>sample string 2</DeviceName>
    <IsThisDevice>true</IsThisDevice>
    <LeaseUntilUtc>2026-10-27T08:47:35.8451078+00:00</LeaseUntilUtc>
    <PreferredDeviceId>sample string 4</PreferredDeviceId>
    <PreferredDeviceName>sample string 5</PreferredDeviceName>
  </BadgeSweeper>
  <PendingCommand>
    <AcknowledgedAtUtc>2026-10-27T08:47:35.8451078+00:00</AcknowledgedAtUtc>
    <AttemptCount>6</AttemptCount>
    <Command>sample string 2</Command>
    <CorrelationId>0aeac195-9fb8-42df-b402-571455f5250d</CorrelationId>
    <Id>1</Id>
    <PayloadJson>sample string 3</PayloadJson>
    <RequestedAtUtc>2026-10-27T08:47:35.8451078+00:00</RequestedAtUtc>
  </PendingCommand>
  <PendingLogRequest>
    <CorrelationId>174b7d4c-f953-43cb-ad6e-71ae2a90c2ae</CorrelationId>
    <DaysBack>64</DaysBack>
    <Id>1</Id>
    <RequestedAtUtc>2026-10-27T08:47:35.8451078+00:00</RequestedAtUtc>
  </PendingLogRequest>
  <ServerTimeUtc>2026-10-27T08:47:35.8451078+00:00</ServerTimeUtc>
</KioskHeartbeatResponseDTO>