...
| Note |
|---|
The Location Service module is dependent on Orbita Blaze being available and configured. |
| Table of Contents |
|---|
Dependencies
The Location Service module is dependent on the following modules:
Methods
renderDetails
Renders markup for the details overlay for a location card based on the provided location data.
...
Returns: A promise that will resolve with the rendered details markup for the provided location.
search
Searches for locations using Blaze based on a query
...
The promise will reject in the case of a Blaze lookup failure.
getByOrbitaId
Retrieves a location record by its Orbita ID
...
Returns: A promise that will resolve with the location record.
format
format is a container for the following methods:
fromOrbita
Formats a raw Orbita record into the intermediary model.
...
Returns: The formatted location.
fromElastic
Formats a raw Elastic result into the intermediary model.
...
Returns: The formatted location.
| Anchor | ||||
|---|---|---|---|---|
|
Certain methods provide an option of returning data raw from Orbita or in the format of the intermediary model that serves as an interface for other modules using the Location Service module. The intermediary location model is:
id (string): The Orbita ID of the location record
name (string): facilityName from the Orbita record
Endpoints
POST: /[Project ID]/location-service/data/providers-by-location
Posting a payload such as:
...