The Location Object provides a data structure for managing locations, such as geographic regions or specific areas.
Module: Places
Collection: Locations
Object Identifier: places.location
| Friendly Field Name | Data Field Name | General Data Type | Description | Optimised for Searching |
|---|---|---|---|---|
| UUID | uuid | UUID | Universally Unique Identifier for each location object. | Yes |
| Application UUID | app_uuid | UUID | Identifier for the associated application | Yes |
| Application Context Ref | app_context_ref | Text (max length 50) | You can use this field to provide searchable context to your object – for example this may be an external identifier, or a lookup UUID to another object in your application. | Yes |
| Sub UUID | sub_uuid | UUID | Similar to the Application Context Ref, This field can be used to store a UUID to another Object. For example, you may be recording an event for an asset – this field would be the preferred field to store the asset UUID to which the event relates. | Yes |
| Label | label | Text (max length 50) | Label for easy identification of the location. | Yes |
| Location Code | location_code | Text (max length 50) | Text code or application ID representing the location. | Yes |
| Location Name | location_name | Text (max length 50) | Name of the location. | Yes |
| Linked Address UUID | linked_addr_uuid | UUID | Identifier for an organisation Object in the places.address Collection. The Address Object must already exist in that Collection, otherwise an error will occur when creating the new Object. | Yes |
| Longitude | longitude | Number | Longitude geo-coordinate for the location. | No |
| Latitude | latitude | Number | Latitude geo-coordinate for the location. | No |
| Taxonomy | location_taxonomy | Text (max length 50) | Internal categorisation for the location. (Default is ‘location’). | Yes |
| Meta Data | meta_data | Text | Additional meta data for the location. | No |
| Created At | created_at | DateTime | Timestamp when the location record was created. | No |
| Updated At | updated_at | DateTime | Timestamp when the location record was last updated. | No |
| Created By | created_by | Text (max length 50) | You can use this field to record who or what created the Object record. | No |
| Updated By | updated_by | Text (max length 50) | You can use this field to record who or what last updated the Object record. | No |