Coordinate
GET /services/coordinate/locations/{locationId}/capabilities
Changed onGets all capability data given a location ID
Request
- Base URLhttps://api.smartthings.com/v1
- AuthOAuth 2Implicithttps://auth-global.api.smartthings.comScopesr:locations:*, mobile
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
locationIdstring required
A unique location identifier. This is not guaranteed to be a valid UUID.
Query parameters
postalCodestring
Postal code of a specific alert. To use of this query, query "name=alert" is REQUIRED and not to combine with any other capabilty.
namestring
Comma separated string of capabilities (alert, weather, airQuality, forecast, airQualityForcast). For example, "weather,airQuality"
Headers
Authorizationstring string required
OAuth token
Response
Success
Example response
{
"locationId": "fb9e719c-e432-4dc3-86b3-7b64ce76c1dc",
"forecast": {
"precip1Hour": {
"value": 0,
"unit": "mm"
},
"precip6Hour": {
"value": 0,
"unit": "mm"
},
"precip24Hour": {
"value": 0.05,
"unit": "mm"
},
"snow1Hour": {
"value": 0,
"unit": "cm"
},
"snow6Hour": {
"value": 0,
"unit": "cm"
},
"snow24Hour": {
"value": 0,
"unit": "cm"
},
"temperature1Hour": {
"value": 30,
"unit": "C"
},
"temperature2Hour": {
"value": 30,
"unit": "C"
},
"temperature3Hour": {
"value": 30,
"unit": "C"
},
"temperature4Hour": {
"value": 30,
"unit": "C"
},
"temperature5Hour": {
"value": 30,
"unit": "C"
},
"temperature6Hour": {
"value": 30,
"unit": "C"
},
"temperature7Hour": {
"value": 30,
"unit": "C"
},
"temperature8Hour": {
"value": 30,
"unit": "C"
},
"temperature9Hour": {
"value": 30,
"unit": "C"
},
"temperature10Hour": {
"value": 30,
"unit": "C"
},
"temperature11Hour": {
"value": 30,
"unit": "C"
},
"temperature12Hour": {
"value": 30,
"unit": "C"
},
"lastUpdateTime": {
"value": "2020-06-18T18:12:57.865Z"
}
},
"weather": {
"cloudCeiling": {
"value": 800,
"unit": "m"
},
"cloudCoverPhrase": {
"value": "Partly Cloudy"
},
"relativeHumidity": {
"value": 95,
"unit": "%"
},
"sunriseTimeLocal": {
"value": "2018-12-10T07:34:27Z"
},
"sunsetTimeLocal": {
"value": "2018-12-10T17:27:59Z"
},
"temperature": {
"value": 38,
"unit": "C"
},
"temperatureFeelsLike": {
"value": 38,
"unit": "C"
},
"dailyOr24hMinTemperature": {
"value": 15,
"unit": "C"
},
"dailyOr24hMaxTemperature": {
"value": 40,
"unit": "C"
},
"uvDescription": {
"value": "Low"
},
"uvIndex": {
"value": 1
},
"visibility": {
"value": 10,
"unit": "Km"
},
"weatherDetailUrl": {
"value": "https://ssiotw.kr-weathernews.com/mv3/html/main.html?region=1114000000"
},
"windDirection": {
"value": 10,
"unit": "°"
},
"windDirectionCardinal": {
"value": "ESE"
},
"windGust": {
"value": 10,
"unit": "Km/h"
},
"windSpeed": {
"value": 2,
"unit": "Km/h"
},
"wxPhraseLong": {
"value": "Partly Cloudy"
},
"lastUpdateTime": {
"value": "2020-06-18T18:12:57.865Z"
}
},
"airQuality": {
"o3Amount": {
"value": 10,
"unit": "μg/m^3"
},
"o3Index": {
"value": 50,
"unit": "EPA"
},
"airQualityIndex": {
"value": 1,
"unit": "CAQI"
},
"no2Amount": {
"value": 41.4,
"unit": "μg/m^3"
},
"no2Index": {
"value": 21,
"unit": "EPA"
},
"so2Amount": {
"value": 26.2,
"unit": "μg/m^3"
},
"so2Index": {
"value": 14,
"unit": "EPA"
},
"coAmount": {
"value": 8020.3,
"unit": "μg/m^3"
},
"coIndex": {
"value": 76,
"unit": "EPA"
},
"pm10Amount": {
"value": 154.5,
"unit": "μg/m^3"
},
"pm10Index": {
"value": 1,
"unit": "EPA"
},
"pm25Amount": {
"value": 35,
"unit": "μg/m^3"
},
"pm25Index": {
"value": 1,
"unit": "EPA"
},
"lastUpdateTime": {
"value": "2020-06-18T18:12:57.865Z"
}
},
"airQualityForecast": {
"pm10Index1Hour": {
"value": 1
},
"pm10Index2Hour": {
"value": 1
},
"pm10Index3Hour": {
"value": 1
},
"pm10Index4Hour": {
"value": 1
},
"pm10Index5Hour": {
"value": 1
},
"pm10Index6Hour": {
"value": 1
},
"pm10Index7Hour": {
"value": 1
},
"pm10Index8Hour": {
"value": 1
},
"pm10Index9Hour": {
"value": 1
},
"pm10Index10Hour": {
"value": 1
},
"pm10Index11Hour": {
"value": 1
},
"pm10Index12Hour": {
"value": 1
},
"pm10Amount1Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount2Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount3Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount4Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount5Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount6Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount7Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount8Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount9Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount10Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount11Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm10Amount12Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Index1Hour": {
"value": 1
},
"pm25Index2Hour": {
"value": 1
},
"pm25Index3Hour": {
"value": 1
},
"pm25Index4Hour": {
"value": 1
},
"pm25Index5Hour": {
"value": 1
},
"pm25Index6Hour": {
"value": 1
},
"pm25Index7Hour": {
"value": 1
},
"pm25Index8Hour": {
"value": 1
},
"pm25Index9Hour": {
"value": 1
},
"pm25Index10Hour": {
"value": 1
},
"pm25Index11Hour": {
"value": 1
},
"pm25Index12Hour": {
"value": 1
},
"pm25Amount1Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount2Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount3Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount4Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount5Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount6Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount7Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount8Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount9Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount10Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount11Hour": {
"value": 30,
"unit": "μg/m^3"
},
"pm25Amount12Hour": {
"value": 30,
"unit": "μg/m^3"
},
"lastUpdateTime": {
"value": "2020-06-18T18:12:57.865Z"
}
}
}Changes
- warning
deleted the
queryrequest parametergeoplaceId
- warning
- info
added the new optional
queryrequest parameterpostalCode
- info