Watch our RX24 Keynotes!

Model Map

Model Map

Key
A required field.
A property on the database.
Not mapped to the database. These fields are computed and are only available in the object.
These fields are available where Lava is supported.
These methods or fields are obsolete and should not be used.

Model Details

Show: Methods

Location

Location Entity class. A location in Rock is any physical place. It could be a street address, building, floor, room, kiosk location, etc. A location is also stackable/hierarchical. For example for a church's campus Campus can have multiple buildings or facilities, each building can be multi story and a story can have multiple rooms.
Properties
AdditionalLavaFields
AssessorParcelId Gets or sets the Local Assessor's parcel identification value that is linked to the location.
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
Barcode Gets or sets the barcode.
CampusId Gets the campus that is at this location, or one of this location's parent location
ChildLocations Gets or sets a collection of child Locations associated that inherit for this location. This property will only return the immediate descendants of this locations.
City Gets or sets the city component of the Location's Street/Mailing Address.
ContextKey
Country Gets or sets the country component of the Location's Street/Mailing Address.
County Gets or sets the county.
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
Distance Gets the distance (in miles). Note, this just stores whatever value was passed into SetDistance Some of the REST APIs, such as Groups/ByLocation, will set this for you
EncryptedKey
EntityStringValue
FirmRoomThreshold Gets or sets threshold that will prevent checkin (no option to override)
ForeignGuid
ForeignId
ForeignKey
FormattedAddress Gets the formatted address.
FormattedHtmlAddress Gets the formatted HTML address.
GeocodeAttemptedDateTime Gets and sets the date and time that an attempt was made to geocode the Location's address.
GeocodeAttemptedResult Gets or sets the result code returned by geocoding service during the last geocode attempt.
GeocodeAttemptedServiceType Gets or sets the component name of the Geocoding service that attempted the most recent address Geocode attempt.
GeocodedDateTime Gets or sets date and time that this Location's address has been successfully geocoded.
GeoFence Gets or sets the geographic parameter around the a Location's GeoPoint. This can also be used to define a large area like a neighborhood.
GeoFenceCoordinates Gets the GeoFence coordinates.
GeoPoint Gets or sets the GeoPoint (GeoLocation) for the location
GooglePolygon Gets the polygon for Google maps.
GroupLocations Gets or sets a collection containing the GroupLocations that reference this Location.
Guid
Id
IdKey
Image Gets or sets the image.
ImageId Gets or sets the image identifier.
IsActive Gets or sets a value indicating whether this instance is active.
IsGeoPointLocked Gets or sets flag indicating if GeoPoint is locked (shouldn't be geocoded again)
IsNamedLocation Gets or sets a value indicating whether this instance is a named location.
IsValid Gets a value indicating whether this instance is valid.
Item
Latitude Gets the latitude ( use GeoPoint to set a latitude/longitude values ).
LocationTypeValue Gets or sets the location type value.
LocationTypeValueId Gets or sets the Id of the LocationType DefinedValue that is used to identify the type of Location that this is. Examples: Campus, Building, Room, etc These are found in the "Location Type" Defined Type.
Show Values
Longitude Gets the longitude ( use GeoPoint to set a latitude/longitude values ).
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Name Gets or sets the Location's Name.
ParentAuthority Gets the parent authority for the location. Location security is automatically inherited from the parent location, unless explicitly overridden. If there is no parent location, it is inherited from the EntityType
ParentAuthorityPre
ParentLocation Gets or set this Location's parent Location.
ParentLocationId Gets or sets the if the location's parent Location.
PostalCode Gets or sets the Zip/Postal Code component of the Location's Street/Mailing Address.
PrinterDevice Gets or sets the Attendance Printer Device that is used at this Location.
PrinterDeviceId Gets or sets the Device Id of the printer (if any) associated with the location.
SoftRoomThreshold Gets or sets a threshold that will prevent checkin unless a manager overrides
StandardizeAttemptedDateTime Gets or sets the date and time of the last address standardization attempt.
StandardizeAttemptedResult Gets or sets the result code returned from the address standardization service.
StandardizeAttemptedServiceType Gets or set the component name of the service that attempted the most recent address standardization attempt.
StandardizedDateTime Gets or sets the date and time that the Location's address was successfully standardized.
State Gets or sets the State component of the Location's Street/Mailing Address.
Street1 Gets or sets the first line of the Location's Street/Mailing Address.
Street2 Gets or sets the second line of the Location's Street/Mailing Address.
SupportedActions
TypeId
TypeName
UrlEncodedKey
ValidationResults