Core Geolocation SupportLocationParameters for defining a Location objectMust be of type 'location'.Location specification type
The location_info
parameter must contain a comma separated list of IANA codes
or synonyms describing the civicAddress of this location.
The IANA codes and synonyms can be obtained by executing
the CLI command geoloc show civicAddr_mapping.
The
location_info parameter must contain a comma
separated list valid GML elements describing this location.
The
location_info parameter must contain a single
URI parameter which contains an external URI describing this location.
Location informationThe contents of this parameter are specific to the
location format.
location_info = country=US,A1="New York",city_district=Manhattan,
A3="New York", house_number=1633, street=46th, street_suffix = Street,
postal_code=10222,floor=20,room=20A2
location_info = Shape=Sphere, pos3d="39.12345 -105.98766 1920", radius=200
location_info = URI=https:/something.com?exten=${EXTEN}
Fully qualified host nameThis parameter isn't required but if provided, RFC8787 says it MUST be a fully
qualified host name. IP addresses are specifically NOT allowed. The value will be placed
in a loc-src parameter appended to the URI in the
Geolocation header.Location determination methodThis is a rarely used field in the specification that would
indicate the method used to determine the location. Its usage and values should be
pre-negotiated with any recipients.Level of confidenceThis is a rarely used field in the specification that would
indicate the confidence in the location specified. See RFC7459
for exact details.
Sub-parameters:
One of:A percentage indicating the confidence.https://www.rfc-editor.org/rfc/rfc7459ProfileParameters for defining a Profile objectMust be of type 'profile'.PIDF-LO element to place this profile in
Based on RFC5491 (see below) the recommended and default element
is device.
https://www.rfc-editor.org/rfc/rfc5491.html#section-3.4Reference to a location objectReference to a location objectReference to a location objectlocation specification typexxxxNotes to be added to the outgoing PIDF-LO documentThe specification of this parameter will cause a
<note-well> element to be added to the
outgoing PIDF-LO document. Its usage should be pre-negotiated with
any recipients.Sets the value of the Geolocation-Routing header.Sets if empty Civic Address elements should be suppressed
from the PIDF-LO document.Determine which profile on a channel should be usedUse the incoming profile if it exists and has location information, otherwise use the
configured profile if it exists and has location information. If neither profile has location
information, nothing is sent.
Use the configured profile if it exists and has location information, otherwise use the
incoming profile if it exists and has location information. If neither profile has location
information, nothing is sent.
Discard any incoming profile and use the configured profile if it exists and
it has location information. If the configured profile doesn't exist or has no
location information, nothing is sent.
Discard any configured profile and use the incoming profile if it exists and
it has location information. If the incoming profile doesn't exist or has no
location information, nothing is sent.
Get or Set a field in a geolocation profile
The profile parameter to operate on. The following fields from the
Location and Profile objects are supported.Additionally, the inheritable field may be
set to true or false to control
whether the profile will be passed to the outgoing channel.
When used to set a parameter on a profile, if the profile doesn't already exist, a new
one will be created automatically.
The ${GEOLOCPROFILESTATUS} channel variable will be set with
a return code indicating the result of the operation. Possible values are:
SuccessNo or not enough parameters were suppliedThere was an internal error finding or creating a profileThere was an issue specific to the parameter specified
(value not valid or parameter name not found, etc.)