🚧

This streaming API will cannot currently stream more than 1000 active check-in sessions according to the filter. If the filter returns more than 1000 results, the result set will exclude some items according to the sorting parameters. Items will be added or removed from the result set according sort order and limit as they are updated.

This check-in streaming API uses HTTP streaming to send any update to a check-in record (including but not limited to location, status and type), according to the filtering, limit and sort order parameters on the request.

The results are returned in atomic 'changeset' XML elements. Each changeset contains a single 'checkins' element, which can contain one or more 'checkin' elements, and each 'checkin' element contains one updated check-in record.

If the 'changeset' element contains the 'clear' property set to 'true', this means any state maintained on the client side (such as a list of checked-in users) should be reset/cleared prior to processing any of the 'checkin' elements in the changeset. If no client-side state is maintained, this property can be ignored.

If a 'checkin' element contains the 'remove' property set to 'true', this means that the check-in record has been set removed (checked-out) and updates will cease until the user checks in again.

'subtype' values:
manual - check-ins that are initiated manually by the user.
timed - check-ins that are initiated manually by the user with a timer.
auto - check-ins that are initiated automatically by a geofence crossing.

'status' values:
normal - the check-in is does not have a timer, or the timer has not yet expired.
escalated - the check-in timer has expired.

'sort_property' values:
in - sorts the check-ins by the time they were first checked-in.
updated - sorts the check-ins by the time they were last updated.
escalate - sorts the check-ins by the time their expiry time.
location - sorts the check-ins by their last location update time.