Web APISchemas
Schemas
Every payload type the Web API returns and accepts.
api.Anchor
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
OrganisationIDreqstring
BuildingIDstring
BuildingFloorIDstring
FloorIndexreqinteger-2147483648–2147483647
Namereqstring
TransponderIDreqstring
Positionreqapi.AnchorPosition
PositionKindreqstring
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.AnchorCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
Namereqstring1–255 chars
TransponderIDreqstring1–100 chars
BuildingFloorIDstring
BuildingIDstring
FloorIndexinteger-2147483648–2147483647
Positionapi.AnchorPosition
PositionKindstringworld · image
api.AnchorPatch
objectadditionalProperties: falsePropertyTypeDescription · rules
Namestring1–255 chars
BuildingFloorIDstring
BuildingIDstring
FloorIndexinteger-2147483648–2147483647
Positionapi.AnchorPosition
PositionKindstringworld · image
api.AnchorPosition
objectadditionalProperties: falsePropertyTypeDescription · rules
Longitudereqnumber
Latitudereqnumber
Altitudereqnumber
api.Assignment
objectadditionalProperties: falsePropertyTypeDescription · rules
AssignmentIDreqstring
OrganisationIDreqstring
OrderIDreqstring
TransponderIDreqstring
Typereqstring
Namereqstring
Categoryreqstring
Tagsreqstring[]
AssignStartreqstringdate-time
AssignEndstringdate-time
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.AssignmentAttach
objectadditionalProperties: falsePropertyTypeDescription · rules
OrderIDreqstring
AssignmentIDreqstring
TransponderIDreqstring1–100 chars
Namereqstringmax 100 chars
Categorystringmax 100 chars
Tagsstring[]max 20 items, 1–50 chars per item
AssignStartstringdate-time
AssignEndstringdate-time
api.AssignmentCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
Namereqstring1–100 chars
TransponderIDreqstring1–100 chars
TypestringRFID_TAG · TELTONIKA_TAT141 · MULTI_PURPOSE · APP_OWNTRACKS
OrderIDstring
Categorystringmax 100 chars
Tagsstring[]max 20 items, 1–50 chars per item
AssignStartstringdate-time
AssignEndstringdate-time
api.AssignmentPatch
objectadditionalProperties: falsePropertyTypeDescription · rules
Namestring1–100 chars
OrderIDstring
Categorystringmax 100 chars
Tagsstring[]max 20 items, 1–50 chars per item
AssignEndstringdate-time
api.AssignmentsEnd
objectadditionalProperties: falsePropertyTypeDescription · rules
AssignEndstringdate-time
api.AuthKeyOrganisation
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
Namereqstring
api.AuthKeyResponse
objectadditionalProperties: falsePropertyTypeDescription · rules
Organisationreqapi.AuthKeyOrganisation
Tierreqstring
Permissionsreqstring[]
api.Building
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
OrganisationIDreqstring
Namereqstring
IsSyntheticreqboolean
SlotIndexinteger-2147483648–2147483647
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.BuildingCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
Namereqstring1–255 chars
IsSyntheticboolean
SlotIndexinteger0–2147483647
api.BuildingPatch
objectadditionalProperties: falseapi.CurrentAssetAnalyticsBucket
objectadditionalProperties: falsePropertyTypeDescription · rules
Groupstring
TotalAssetsreqinteger≥ 0
SeenLast5mreqinteger≥ 0
SeenLast15mreqinteger≥ 0
SeenLast1hreqinteger≥ 0
SeenLast24hreqinteger≥ 0
StaleAssetsreqinteger≥ 0
UnknownPositionAssetsreqinteger≥ 0
api.CurrentAssetAnalyticsResponse
objectadditionalProperties: falsePropertyTypeDescription · rules
Summaryreqapi.CurrentAssetAnalyticsBucket
api.Device
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
DeviceIDreqstring
OrganisationIDreqstring
Namereqstring
Typereqstring
Modelreqstring
Vendorreqstring
AssignStartreqstringdate-time
AssignEndstringdate-time
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.DeviceHealthResponse
objectadditionalProperties: falseapi.DeviceHealthRow
objectadditionalProperties: falsePropertyTypeDescription · rules
DeviceIDreqstring
DeviceNamereqstring
BatteryChargereqinteger-2147483648–2147483647
Temperaturereqnumber
NetSignalreqinteger-2147483648–2147483647
MemoryLeftreqinteger-2147483648–2147483647
ConnStatusreqinteger0–255
DeviceErrorreqstring
LastSeenreqstringdate-time
api.DeviceHealthSummary
objectadditionalProperties: falsePropertyTypeDescription · rules
Totalreqinteger≥ 0
Onlinereqinteger≥ 0
Offlinereqinteger≥ 0
LowBatteryCountreqinteger≥ 0
HighTempCountreqinteger≥ 0
WeakSignalCountreqinteger≥ 0
ErroredCountreqinteger≥ 0
api.DevicePathEntry
objectadditionalProperties: falsePropertyTypeDescription · rules
DeviceIDreqstring
DeviceNamereqstring
Timereqstringdate-time
PositionFlagreqstringOne of: "" (unset), "U" unknown, "S" stationary, "M" moving, "X" inaccurate, "T" traveling. · U · S · M · X · T, max 1 chars
PositionAltitudereqinteger
AccelerationXreqinteger-2147483648–2147483647
AccelerationYreqinteger-2147483648–2147483647
AccelerationZreqinteger-2147483648–2147483647
Receivedreqstringdate-time
DeviceTimeAtRequestreqstringdate-time
api.DeviceStatus
objectadditionalProperties: falsePropertyTypeDescription · rules
DeviceIDreqstring
OrganisationIDreqstring
DeviceNamereqstring
BoxTypereqstring
BoxModereqstring
BoxPowerreqstring
BoxHoursreqinteger-2147483648–2147483647
BoxErrorreqstring
CustomerIDreqinteger
Protocolreqinteger-2147483648–2147483647
FileNumberreqinteger-2147483648–2147483647
Channelreqinteger0–4294967295
Timereqstringdate-time
Receivedreqstringdate-time
DeviceTimeAtRequestreqstringdate-time
Latencyreqinteger
ConnStatusreqinteger0–255
BatteryChargereqinteger-2147483648–2147483647
MemoryLeftreqinteger-2147483648–2147483647
Temperaturereqnumber
Wattreqnumber
Voltreqnumber
Noisereqinteger-2147483648–2147483647
PositionFlagreqstringOne of: "" (unset), "U" unknown, "S" stationary, "M" moving, "X" inaccurate, "T" traveling. · U · S · M · X · T, max 1 chars
PositionAltitudereqinteger
Satellitesreqinteger-2147483648–2147483647
Cellreqstring
LACreqstring
PLMNreqinteger-2147483648–2147483647
NetProviderreqstring
NetSignalreqinteger-2147483648–2147483647
AccelerationXreqinteger-2147483648–2147483647
AccelerationYreqinteger-2147483648–2147483647
AccelerationZreqinteger-2147483648–2147483647
ReaderStatusreqstring
ReaderPowerreqstring
RecordsCountreqinteger-2147483648–2147483647
Sessionreqstring
api.Floor
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
OrganisationIDreqstring
BuildingIDreqstring
FloorIndexreqinteger-2147483648–2147483647
Namereqstring
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.FloorCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
BuildingIDreqstring
FloorIndexinteger-2147483648–2147483647
Namereqstring1–255 chars
api.FloorPatch
objectadditionalProperties: falsePropertyTypeDescription · rules
Namestring1–255 chars
api.FloorPlan
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
OrganisationIDreqstring
BuildingIDreqstring
BuildingFloorIDreqstring
Namereqstring
ImageHeightreqinteger
ImageWidthreqinteger
ImageSizereqinteger
ImageScalereqnumber
ImageMimeTypereqstring
GeoReferenceOffsetXreqnumber
GeoReferenceOffsetYreqnumber
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.FloorPlanPatch
objectadditionalProperties: falsePropertyTypeDescription · rules
Namestring1–255 chars
ImageScalenumber> 0
GeoReferenceOffsetXnumber
GeoReferenceOffsetYnumber
api.GeoFence
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
OrganisationIDreqstring
Namereqstring
BuildingFloorIDstring
FixedDevicestring
IsPublicreqboolean
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.GeoFenceCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
Namereqstring1–100 chars
PolygonreqobjectA GeoJSON MultiPolygon, or a Polygon read as a MultiPolygon covering one area.
BuildingFloorIDstring
FixedDevicestring1–100 chars
api.GeoFenceEvent
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
EntityTypereqstring
EntityIDreqstring
TransponderIDstring
DeviceIDstring
OrderIDstring
GeoFenceIDreqstring
Edgereqstring
EnteredAtstringdate-time
DwellSecondsinteger0–4294967295
TriggeredAtreqstringdate-time
api.GeoFencePatch
objectadditionalProperties: falsePropertyTypeDescription · rules
Namestring1–100 chars
PolygonobjectA GeoJSON MultiPolygon, or a Polygon read as a MultiPolygon covering one area.
BuildingFloorIDstring
FixedDevicestringmax 100 chars
IsPublicboolean
api.GeoFenceSummaryAnalyticsRow
objectadditionalProperties: falsePropertyTypeDescription · rules
Groupstring
Entriesreqinteger≥ 0
Exitsreqinteger≥ 0
UniqueAssetsreqinteger≥ 0
UniqueOrdersreqinteger≥ 0
AvgDwellSecondsreqnumber
DwellP50Secondsreqnumber
DwellP90Secondsreqnumber
api.GeoMultiPolygon
objectA GeoJSON MultiPolygon.
PropertyTypeDescription · rules
coordinatesreqnumber[][][][]Longitude first. A ring is stored and answered exactly as it was sent: vertex order and winding are preserved, and the closing vertex is neither added nor removed, so an open ring stays open and a closed ring stays closed. 2–2 items, double per item per item per item per item
typereqstringMultiPolygon
api.GeoPoint
objectA GeoJSON Point.
PropertyTypeDescription · rules
coordinatesreqnumber[]Longitude first. A ring is stored and answered exactly as it was sent: vertex order and winding are preserved, and the closing vertex is neither added nor removed, so an open ring stays open and a closed ring stays closed. 2–2 items, double per item
typereqstringPoint
api.GeoPolygon
objectA GeoJSON Polygon.
PropertyTypeDescription · rules
coordinatesreqnumber[][][]Longitude first. A ring is stored and answered exactly as it was sent: vertex order and winding are preserved, and the closing vertex is neither added nor removed, so an open ring stays open and a closed ring stays closed. 2–2 items, double per item per item per item
typereqstringPolygon
api.LivePingProcessedEvent
objectadditionalProperties: falsePropertyTypeDescription · rules
TransponderIDreqstring
TransponderAssignmentIDstring
DeviceIDreqstring
BoxTypereqstring
Longitudereqnumber
Latitudereqnumber
Altitudereqinteger
Timereqstringdate-time
Receivedreqstringdate-time
ProcessedAtreqstringdate-time
OrganisationIDreqstring
OrderIDstring
GeoFenceIDstring
GeoHashstring
BuildingIDstring
BuildingFloorIDstring
FloorIndexreqinteger-2147483648–2147483647
PositionSourcestring
ReaderRoundIDstring
AnchorPrimaryTransponderIDstring
AnchorConfidencenumber
api.LivePingRawEvent
objectadditionalProperties: falsePropertyTypeDescription · rules
TransponderIDreqstring
DeviceIDreqstring
BoxTypereqstring
Longitudereqnumber
Latitudereqnumber
Altitudereqinteger
Timereqstringdate-time
Receivedreqstringdate-time
OrganisationIDreqstring
api.Order
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
OrganisationIDreqstring
Namereqstring
Categoryreqstring
Tagsreqstring[]
CreatedByreqstring
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.OrderActivitySummary
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
Namereqstring
Categoryreqstring
Tagsreqstring[]
CreatedAtreqstring
UpdatedAtreqstring
LastDetectionAtstring
LastActionAtstring
LastActivityAtstring
TotalAssignmentsreqinteger
ActiveAssignmentsreqinteger
DetectedAssignmentsreqinteger
MissingAssignmentsreqinteger
LatestAssignmentIDstring
LatestTransponderIDstring
LatestDeviceIDstring
api.OrderCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
Namereqstring1–100 chars
Transpondersreqstring[]1–100 chars per item
Categorystringmax 100 chars
Tagsstring[]max 20 items, 1–50 chars per item
api.OrderPatch
objectadditionalProperties: falsePropertyTypeDescription · rules
Namereqstring1–100 chars
Categorystringmax 100 chars
Tagsstring[]max 20 items, 1–50 chars per item
api.OrderSummary
objectadditionalProperties: falseapi.OrganisationZoneOccupancyRow
objectadditionalProperties: falsePropertyTypeDescription · rules
GeoFenceIDreqstring
CurrentlyInsidereqinteger≥ 0
UniqueOrdersreqinteger≥ 0
api.Page
objectadditionalProperties: falsePropertyTypeDescription · rules
Limitreqinteger
Totalinteger
NextCursorstring
api.PingActivityAnalyticsPoint
objectadditionalProperties: falsePropertyTypeDescription · rules
Bucketreqstringdate-time
Groupstring
PingCountreqinteger≥ 0
UniqueAssetsreqinteger≥ 0
UniqueOrdersreqinteger≥ 0
ActiveDevicesreqinteger≥ 0
GeoFencePingCountreqinteger≥ 0
UnknownPositionCountreqinteger≥ 0
AvgHitsreqnumber
AvgRSSIreqnumber
LowHitCountreqinteger≥ 0
WeakRSSICountreqinteger≥ 0
api.PingDensityCellDTO
objectadditionalProperties: falsePropertyTypeDescription · rules
Cellreqstring
PingCountreqinteger≥ 0
Transpondersreqinteger≥ 0
api.PingProcessedSlim
objectadditionalProperties: falsePropertyTypeDescription · rules
TransponderIDreqstring
AssignmentIDreqstring
TransponderAssignmentIDreqstring
DeviceIDreqstring
BoxTypereqstring
Timereqstringdate-time
OrderIDreqstring
GeoFenceIDreqstring
BuildingIDstring
BuildingFloorIDstring
FloorIndexreqinteger-2147483648–2147483647
PositionSourcestring
AnchorPrimaryTransponderIDstring
AnchorConfidencenumber
PositionFlagreqstringOne of: "" (unset), "U" unknown, "S" stationary, "M" moving, "X" inaccurate, "T" traveling. · U · S · M · X · T, max 1 chars
api.PingProcessingAnalyticsPoint
objectadditionalProperties: falsePropertyTypeDescription · rules
Bucketreqstringdate-time
Groupstring
PingCountreqinteger≥ 0
ProcessingLatencyP50Msreqnumber
ProcessingLatencyP90Msreqnumber
ProcessingLatencyP99Msreqnumber
IngestToProcessedLatencyP50Msreqnumber
IngestToProcessedLatencyP90Msreqnumber
IngestToProcessedLatencyP99Msreqnumber
api.PositionOverwrite
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
DeviceIDreqstring
OrganisationIDreqstring
Namereqstring
PositionLatitudereqnumber
PositionLongitudereqnumber
PositionAltitudereqnumber
CreatedAtreqstringdate-time
UpdatedAtreqstringdate-time
api.PositionOverwriteCreate
objectadditionalProperties: falsePropertyTypeDescription · rules
DeviceIDreqstring1–50 chars
Namestringmax 255 chars
PositionLatitudereqnumber
PositionLongitudereqnumber
PositionAltitudenumber
api.PositionOverwritePatch
objectadditionalProperties: falsePropertyTypeDescription · rules
IDreqstring
Namestringmax 255 chars
PositionLatitudenumber
PositionLongitudenumber
PositionAltitudenumber