Phoenix Location

Creating immersive experiences with location awareness

DeleteResponse

Properties

Name Type Description

Operations

DeactivateModule
Sets the Project record to inactiveSoapRestC#
DeleteGeofence
Description not availableSoapRestC#
DeleteSite
Description not availableSoapRestC#

Geofence

A geofence is an area around a point of interest that users may enter and exit, resulting in events being triggered and custom actions assigned.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the Geofence[queryable][sortable]
ProjectIdSystem.Int32 The project that this Geofence belongs to[queryable][sortable][required]
NameSystem.String The name of the Geofence[queryable][sortable][required]
TagsSystem.StringA comma delimited string of keywords used to group the Geofences together
CreateDateSystem.DateTime UTC date of when this entity was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this entity was last modified
DescriptionSystem.String An optional verbose description for the geofence[queryable]
AddressSystem.String An optional address describing the location that the geofence encloses[queryable]
ReferenceSystem.String An optional keyword that can be used as an alternative index by external systems[queryable]
RadiusSystem.DoubleAn optional radius (in metres) that encloses the geolocated point and forms the geofence
IsActiveSystem.BooleanUnavailable
ProjectProjectNavigation property to Project [expandable]

GeofenceCreate

Properties

Name Type Description
GeolocationGeolocationThe Geolocation of the Geofence
IdSystem.Int32 the primary identifier of the Geofence[queryable][sortable]
ProjectIdSystem.Int32 The project that this Geofence belongs to[queryable][sortable][required]
NameSystem.String The name of the Geofence[queryable][sortable][required]
TagsSystem.StringA comma delimited string of keywords used to group the Geofences together
CreateDateSystem.DateTime UTC date of when this entity was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this entity was last modified
DescriptionSystem.String An optional verbose description for the geofence[queryable]
AddressSystem.String An optional address describing the location that the geofence encloses[queryable]
ReferenceSystem.String An optional keyword that can be used as an alternative index by external systems[queryable]
RadiusSystem.DoubleAn optional radius (in metres) that encloses the geolocated point and forms the geofence
IsActiveSystem.BooleanUnavailable
ProjectProjectNavigation property to Project [expandable]

GeofenceRetrieve

Properties

Name Type Description
GeolocationGeolocationThe geolocation of the Geofence.
IdSystem.Int32 the primary identifier of the Geofence[queryable][sortable]
ProjectIdSystem.Int32 The project that this Geofence belongs to[queryable][sortable][required]
NameSystem.String The name of the Geofence[queryable][sortable][required]
TagsSystem.StringA comma delimited string of keywords used to group the Geofences together
CreateDateSystem.DateTime UTC date of when this entity was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this entity was last modified
DescriptionSystem.String An optional verbose description for the geofence[queryable]
AddressSystem.String An optional address describing the location that the geofence encloses[queryable]
ReferenceSystem.String An optional keyword that can be used as an alternative index by external systems[queryable]
RadiusSystem.DoubleAn optional radius (in metres) that encloses the geolocated point and forms the geofence
IsActiveSystem.BooleanUnavailable
ProjectProjectNavigation property to Project [expandable]

Operations

CreateGeofence
Description not availableSoapRestC#
GetGeofence
Description not availableSoapRestC#
ListGeofences
Description not availableSoapRestC#
UpdateGeofence
Description not availableSoapRestC#

GeofenceUpdate

Properties

Name Type Description
GeolocationGeolocationThe Geolocation of the Geofence.
IdSystem.Int32 the primary identifier of the Geofence[queryable][sortable]
ProjectIdSystem.Int32 The project that this Geofence belongs to[queryable][sortable][required]
NameSystem.String The name of the Geofence[queryable][sortable][required]
TagsSystem.StringA comma delimited string of keywords used to group the Geofences together
CreateDateSystem.DateTime UTC date of when this entity was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this entity was last modified
DescriptionSystem.String An optional verbose description for the geofence[queryable]
AddressSystem.String An optional address describing the location that the geofence encloses[queryable]
ReferenceSystem.String An optional keyword that can be used as an alternative index by external systems[queryable]
RadiusSystem.DoubleAn optional radius (in metres) that encloses the geolocated point and forms the geofence
IsActiveSystem.BooleanUnavailable
ProjectProjectNavigation property to Project [expandable]

Project

Refers to the core PhoenixIdentity.Project table

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 the central Project in the PhoenixIdentity module[queryable][sortable][required]
Beacon_ProximityUUIDSystem.GuidUnavailable
MetaDataParametersList<KeyValuePair<string, string>>Optional data to extend the definition of a Syndicate Project
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

Operations

ActivateModule
Activates the module for a particular project by creating a new Project recordSoapRestC#
GetModuleSettings
Gets the DataCapture.Project recordSoapRestC#
UpdateModuleSettings
Updates the settings for this Project recordSoapRestC#

Site

A Site is a location that may contain multiple Beacons.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the Site[queryable][sortable]
ProjectIdSystem.Int32 The project that this Site belongs to[queryable][sortable][required]
NameSystem.String The human readable name given to this Site[queryable][sortable][required]
DescriptionSystem.String A verbose description of the Site[queryable][sortable]
Beacon_MajorSystem.Int32the major portion of the Beacon identifier
MetaDataParametersList<KeyValuePair<string, string>>optional XML data to associate with this Site
CreateDateSystem.DateTime UTC date of when this entity was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this entity was last modified
ReferenceSystem.String An optional keyword that can be used as an alternative index by external systems[queryable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateSite
Description not availableSoapRestC#
GetSite
Description not availableSoapRestC#
ListSites
Description not availableSoapRestC#
UpdateSite
Description not availableSoapRestC#