Skip to main content
Version: v4 (Stable)

Common Data Types

PagingCollection<T>

A generic wrapper for paginated list responses.

PropertyTypeDescription
pagingPagingPaging information.
itemsIEnumerable<T>List of elements of type T.

Paging

Pagination metadata returned with collection responses.

PropertyTypeDescription
offsetuintThe offset of the first item you want results for.
limituintThe maximum number of items you want included in the item set.
totalulongThe total item count.

Location

Geographic location information associated with an object.

PropertyTypeDescription
latitudedouble?Latitude of object.
longitudedouble?Longitude of object.
horizontalAccuracydouble?Horizontal accuracy.
altitudedouble?Altitude.
verticalAccuracydouble?Vertical accuracy.
dateDateTime?Timestamp of location.
beaconListList<Beacon>Beacon list associated to object.

Beacon

A proximity beacon associated with a location.

PropertyTypeDescription
idstringIdentifier of beacon.
namestringName of beacon.
typeBeaconTypeType of beacon.
accuracydouble?Accuracy of location.
dateDateTime?Timestamp of location.

BeaconType

Enumeration of beacon types.

TypeValueDescription
Undefined0Unknown type of beacon.
WIFI1WIFI access point.
Bluetooth2Bluetooth connector.
NFC3NFC receiver.
DECT4DECT transmitter.
Radio5Radio relay.

LangString

A localized string for a specific language.

PropertyTypeDescription
langIdushort?Language localization ID (1033: English, 1036: French).
textstringText depending on language.

MultiLangString

A collection of localized strings for multiple languages.

PropertyTypeDescription
langStringsList<LangString>List of strings for different languages.