Skip to content

Services

Michelle Staley edited this page Jan 18, 2023 · 3 revisions

Operations to query for and subscribe to location service data, currently consisting of current weather conditions, weather forecast, and air quality data.

Functions

Note: The list of functions can be found here.

  • getLocationServiceInfo - Returns the location's city, latitude, longitude, and list of locations service subscriptions. Requires locationId UUID of the location. If the client is configured with a location ID this parameter can be omitted.

  • getServiceCapabilities - Returns the list of location service capability names available for this location. Currently airQuality, forecast, and weather, for locations have geo-coordinates set. Requires locationId UUID of the location. If the client is configured with a location ID this parameter can be omitted.

  • createSubscription - Subscribe to changes in any location service capability value. Requires the subscription definiton, locationId UUID of the location. If the client is configured with a location ID this parameter can be omitted. Also requires installedApp UUID of the installed app instance. If the client is configured with a installed App ID this parameter can be omitted.

  • updateSubscription - Updates a location service subscription. Requires the id UUID of the subscription, the subscription definiton, locationId UUID of the location. If the client is configured with a location ID this parameter can be omitted. Also requires installedApp UUID of the installed app instance. If the client is configured with a installed App ID this parameter can be omitted.

  • getCapability - Gets a capability for a service. Requires location id, and the capability (comma separated string of capabilities - weather, airQuality, forecast, airQualityForcast - for example, "weather,airQuaility&quot

  • getCapabilities - Get multiple capabilities. Requires location id, and the capability (comma separated string of capabilities - weather, airQuality, forecast, airQualityForcast - for example, "weather,airQuaility&quot

Clone this wiki locally