Find dimension items by keys

Find dimension items(such as city, province) by keys.

Request format

METHOD {URI-scheme}://{apigw-address}/solar-api/{version}/dimensionService/findByKeys

Request Parameters

Name Location Required Datatype Description
token Query false String token, required when user account calls Solar API
orgId Query false String orgnization Id, required when service account calls Solar API
table Query true String table name, such as city_2016, province, country
keys Query true String dimension keys with comma as splitter

Response Parameters

Name Datatype Description
item attributes… String item attributes…

Error Codes

See Common response code.

Example

Request Example

GET
https://{apigw-address}/solar-api/v1.0/dimensionService/findByKeys?token=APP_PORTAL_S_LVtNJAj******3KLD&table=city&keys=110101,110102

Response Example

{
    "data": {
        "110101": {
            "country": "CHN",
            "province_id": "110000",
            "name_i18n": "{\"defaultValue\":\"city1\",\"i18nValue\":{\"en_US\":\"city1\",\"zh_CN\":\"城市1\"}}",
            "lon": 116.416357,
            "lat": 39.928353
        },
        "110102": {
            "country": "CHN",
            "province_id": "110000",
            "name_i18n": "{\"defaultValue\":\"city2\",\"i18nValue\":{\"en_US\":\"city2\",\"zh_CN\":\"城市2\"}}",
            "lon": 116.365868,
            "lat": 39.912289
        }
    },
    "status": 0,
    "msg": "success"
}