Skip to main content
POST
/
api
/
proximity
/
getLocomotionEventsForTag
Get locomotion events for tag
curl --request POST \
  --url https://api2.rhombussystems.com/api/proximity/getLocomotionEventsForTag \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "createdAfterMs": 1640995200000,
  "createdBeforeMs": 1640995200000,
  "limit": 100,
  "movementFilter": "ARRIVAL",
  "tagUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "locomotionEvents": [
    {
      "baseStationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "gpsLocation": {
        "error": {
          "majorAxis": 123,
          "minorAxis": 123,
          "rotation": 123
        },
        "floor": 123,
        "lat": 123,
        "lon": 123
      },
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "movement": "ARRIVAL",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "tagUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting locomotion events for a specified proximity tag with filtering options.

createdAfterMs
integer<int64> | null

Filter events created after this timestamp in milliseconds

Example:

1640995200000

createdBeforeMs
integer<int64> | null

Filter events created before this timestamp in milliseconds

Example:

1640995200000

limit
integer<int32> | null

Maximum number of events to return

Example:

100

movementFilter
enum<string> | null

Filter events by locomotion movement type

Available options:
ARRIVAL,
DEPARTURE,
MOVED_SIGNIFICANTLY,
UNKNOWN
tagUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing locomotion events for a specified proximity tag.

error
boolean | null
errorMsg
string | null
locomotionEvents
object[] | null

List of locomotion events for the specified tag

warningMsg
string | null