APIs

  1. Admin Asset Tag Status (v1)

    The Admin Asset Tag Status API provides access to Asset Tag Status files stored within the Atrius Blob Storage service.

  2. Admin Buildings (v1)

    The Admin Buildings API provides access to create, read and update building resources. Buildings are a component of the organizational hierarchy. A site is composed of buildings and a building is composed of floors. An example of this would be a college campus (site) with an arts building (building) and three floors (floors).

  3. Admin Categories (v1)

    The Categories API provides access to create, read and update Category resources. Category resources are synonymous with tags and provide a mechanism for adding additional contextual information about a resource.

  4. Admin Categories (v1) - BETA

    The Categories API provides access to create, read and update Category resources. Category resources are synonymous with tags and provide a mechanism for adding additional contextual information about a resource.

  5. Admin Control Groups (v1)

    The Admin Control Groups API provides access to create, read and update control group resources.

  6. Admin Controllers (v1)

    The Admin Controllers API provides access to create read and update controller resources, as well access to the associated network layout and connection information.

  7. Admin Egw Status (v1)

    The Egw Status API provides access to operations that retrieve historical status information. This status data is ingested and sanitized by the Atrius position processing system. Note, there may some delay between a position sent from a device and becoming available through this API.

  8. Admin Floor Map Tokens {v1)

    The Floor Map Tokens API provides access to read floors with map token resources. These routes append map tokens to the floor object. These map tokens are retrieved using the information in the map token resources.

  9. Admin Floor Space Catalogs (v1)

    The Floor Space Catalogs API provides access to operations that retrieve and update floor space catalogs.

  10. Admin Floor Space Maps (v1)

    The Floor Space Map API provides access to create, read and update floor space map resources. A floor space can currently only support a single floor space map. Floor space maps can be loaded with optional geotransform information to provide a spatial context to the floor space.

  11. Admin Floor Spaces (v1)

    The Floor Space API provides access to create, read and update floor space resources. Floor Spaces define a local positioning coordinate system in meter. They also can define a transformation between the local coordinate system to the global coordinate system via the geotransform attributes. Floor Spaces are a component of the organizational hierarchy and reside under the floors in the hierarchy.

  12. Admin Floors (v1)

    The Floors API provides access to create, read and update floor resources. Floors are a component of the organizational hierarchy. A building is composed of one or more floors.

  13. Admin Geotransforms (v1)

    The Geotransforms API provides a mechanism for generating geotransform objects from an array of ground control points.

  14. Admin Known Device Property Type (v1)

    The Asset Known Device Property Type API provides access to known device property type resources. Known Devices Property Type resources provide a typing system for optional properties associated with a known device.

  15. Admin Known Devices (v2)

    The Asset Known Device API provides access to create, read and update known device resources. Known Devices resources connect a known entity like a person or asset to one or more devices. A known device id is added to a position object as the position streams through the system. A known device can be associated with a single physical device with multiple ids (wifi, bluetooth, and/or bls) or can be associated with multiple physical devices. In addition, known devices can be assigned categories.

  16. Admin Lights Map (v1)

    The Lights Map API provides access to operations to retrieve the current lights map for an Eclypse Controller.

  17. Admin Luminaire Positions (v1)

    The Luminaire Positions API provides access to operations that retrieve and update luminaire positions.

  18. Admin Luminaire Summaries (v1)

    The Luminaire Summaries API provides access to operations that retrieve luminaire summaries.

  19. Admin Luminaire Types (v1)

    The Luminaire Types API provides access to operations that retrieve and update luminaire types.

  20. Admin Map Tiling (v1)

    The Map Tiling API provides access to operations for kicking off map tiling tasks

  21. Admin Map Tokens (v1)

    The Map Tokens API provides access to create, read and update map token resources. Map Tokens are resources that define authentication information to external mapping systems. Typically, Atrius uses the ArcGIS Online mapping system for rendering and serving out map tiles for a floor. If a map service is "secured" on ArcGIS Online, then the authentication information for that service must be stored as a map token and then associated with the floor.

    Once the map token authentication information is stored in this system, a new token will be generated for each request for a map token. The Atrius system will proxy through to ArcGIS Online to request a new token using the authentication information stored in this resource.

  22. Admin Organizations (v1)

    The Admin Organization API provides access to create, read and update organization resources. Organizations are the top level of the organizational hierarchy. All child resources are associated to organizations either directly or through intermediary resources. Only a partner can create or modify an organization.

  23. Admin Reprocess Positions (v2)

    The Reprocess Positions API provides access to send position reprocessing messages to the processing queue. This api uses the V2 reprocessing stack.

  24. Admin Site Group Sites (v1)

    The Site Group Sites API provides access to create, read and update site group site resources. Site Group Sites define the many to many relationship between sites and site groups.

  25. Admin Site Groups (v1)

    The Admin Site Group API provides access to create, read and update site group resources. Site Groups define a collection of related sites. There is a many to many relationship between site groups and sites. Site metrics are rolled up into site group metrics.

  26. Admin Sites (v1)

    The Sites API provides access to create, read and update site resources. Sites resources are a key element of the organizational hierarchy. A site resource is a discrete location in the world. It can be composed of one (retail store) or more buildings (college campus). Configuration and metric calculations are tied directly to the site configuration.

  27. Admin Task Status (v1)

    The Admin Task Status API provides access to read the status of asynchronous tasks in the Atrius system. These tasks include site hexgrid generation and position processing. Note: This table is auto-cleaned on a nightly basis. Finished tasks greater than 24 hours old are pruned from the system.

  28. Admin Zones (v1)

    The Zone API provides access to create, read and update zone resources. Zones represent physical areas on a floor where positions are collected and metrics are processed. A position must exist in a zone in order for it to be collected by the system. Zones are represented as GeoJSON features.

    There are three types of zones:

    • Capture Area (multi-floor | site optional) - Represent the maximum bounds for collecting positions. Any positions identified as outside of the capture area are dropped from the system.
    • Metric (site required) - Represent areas for position and metric collection. The collection of zone represent a site metric.
    • Action (site optional) - Represent areas on the floor where client actions should occur. The messageContent is open for client applications to store application specific content.
  29. Insights Categories (v1)

    The Categories API provides access to retrieve Category resources. Category resources are a mechanism for adding additional contextual information about a resource.

  30. Insights Floor Map Tokens (v1)

    The Floor Map Tokens API Provides Access To Operations That Retrieve Floor Map Tokens Which Are Used To Access Map Services For A Site.

  31. Insights Floor Spaces (v1)

    The Floor Space API provides access to create, read and update floor space resources. Floor Spaces define a local positioning coordinate system in meter. They also can define a transformation between the local coordinate system to the global coordinate system via the geotransform attributes. Floor Spaces are a component of the organizational hierarchy and reside under the floors in the hierarchy.

  32. Insights Known Device Property Type (v1)

    The Asset Known Device Property Type API provides access to known device property type resources. Known Devices Property Type resources provide a typing system for optional properties associated with a known device.

  33. Insights Known Devices (v2)

    The Known Device API provides access retrieve known device resources. Known Devices resources can connect an anonymous entity like a person or asset to one or more Known Devices.

  34. Insights Live Positions (v1)

    The Live Positions API provides access to real time and/or near real time positions and position aggregates.

  35. Insights Live Positions (v1) - BETA

    The Live Positions API provides access to real time and/or near real time positions and position aggregates.

  36. Insights Organizations (v1)

    The Admin Organization API provides access to read resources. Organizations are the top level of the organizational hierarchy. All child resources are associated to organizations either directly or through intermediary resources. Only a partner can create or modify an organization.

  37. Insights Positions (v3)

    The Positions API provides access to operations that retrieve live & historical position information. This position data is ingested and sanitized by the Atrius position processing system. Note, there may some delay between a position sent from a device and becoming available through this API.

  38. Insights Product Sources (v1)

    The Product Sources API provides access to retrieve the available data sources (e.g. Assets, Navigator, etc.) for Atrius messages.

  39. Insights Sites (v1)

    The Sites API provides access to read site resources. Sites resources are a key element of the organizational hierarchy. A site resource is a discrete location in the world. It can be composed of one (retail store) or more buildings (college campus). Configuration and metric calculations are tied directly to the site configuration.

  40. Insights Zones (v1)

    The Zone API provides access to read zone resources. Zones represent physical areas on a floor where positions are collected and metrics are processed. A position must exist in a zone in order for it to be collected by the system. Zones are represented as GeoJSON features.

    There are three types of zones:

    • Capture Area (multi-floor | site optional) - Represent the maximum bounds for collecting positions. Any positions identified as outside of the capture area are dropped from the system.
    • Metric (site required) - Represent areas for position and metric collection. The collection of zone represent a site metric.
    • Action (site optional) - Represent areas on the floor where client actions should occur. The messageContent is open for client applications to store application specific content.
  41. Live View Categories (v1)

    The Categories API provides access to retrieve Category resources. Category resources are a mechanism for adding additional contextual information about a resource.

  42. Live View Floor Map Tokens (v1)

    The Floor Map Tokens API Provides Access To Operations That Retrieve Floor Map Tokens Which Are Used To Access Map Services For A Site.

  43. Live View Floors (v1)

    The Floors API provides access to read floor resources. Floors are a component of the organizational hierarchy. A building is composed of one or more floors.

  44. Live View Known Devices (v2)

    The Known Device API provides access retrieve known device resources. Known Devices resources can connect an anonymous entity like a person or asset to one or more Known Devices.

  45. Live View Live Positions (v1)

    The Live Positions API provides access to real time and/or near real time positions and position aggregates.

  46. Live View Organizations (v1)

    The Admin Organization API provides access to read resources. Organizations are the top level of the organizational hierarchy. All child resources are associated to organizations either directly or through intermediary resources. Only a partner can create or modify an organization.

  47. Live View Product Sources (v1)

    The Product Sources API provides access to retrieve the available data sources (e.g. Assets, Navigator, etc.) for Atrius messages.

  48. Live View Sites (v1)

    The Sites API provides access to read site resources. Sites resources are a key element of the organizational hierarchy. A site resource is a discrete location in the world. It can be composed of one (retail store) or more buildings (college campus). Configuration and metric calculations are tied directly to the site configuration.

  49. Live View Zones (v1)

    The Zone API provides access to read zone resources. Zones represent physical areas on a floor where positions are collected and metrics are processed. A position must exist in a zone in order for it to be collected by the system. Zones are represented as GeoJSON features.

    There are three types of zones:

    • Capture Area (multi-floor | site optional) - Represent the maximum bounds for collecting positions. Any positions identified as outside of the capture area are dropped from the system.
    • Metric (site required) - Represent areas for position and metric collection. The collection of zone represent a site metric.
    • Action (site optional) - Represent areas on the floor where client actions should occur. The messageContent is open for client applications to store application specific content.
  50. Navigator Initialization (v1)

    The Navigator Initialization API provides access to retrieve site configuration and connection information to the Atrius position processing service. This API provides all of the information necessary to send position data into the Atrius system.

  51. Navigator Initialization (v2)

    The Navigator Initialization API provides access to retrieve site configuration and connection information to the Atrius position processing service. This API provides all of the information necessary to send position data into the Atrius system.