Get supported domain points¶
Get supported domain points by specified device types.
Request Format¶
METHOD {URI-scheme}://{apigw-address}/solar-api/{version}/mdmService/getSupportedPoints
Request Parameter¶
Name | Location | Required | Datatype | Description |
---|---|---|---|---|
type | Query | true | String | device type, see device list on Solar API overview for details |
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 |
language | Query | false | String | language, Chinese: zh-CN, English: en-US, default as en-US |
Response Parameters¶
Name | Datatype | Description |
description | String | description |
domainPoint | String | domain point |
units | String | units |
type | String | data type |
Error Codes¶
See Common response code.
Example¶
Request Example¶
GET
https://{apigw-address}/solar-api/v1.0/mdmService/getSupportedPoints?type=102&token=APP_PORTAL_S_P3HKyz7Qpk7FUwSxxxxxxxv3M86n4ZZ
Response Example¶
{
"data": [
{
"description": "Site Active Power",
"units": "kW",
"type": "Double",
"domainPoint": "SITE.GenActivePW"
},
{
"description": "Inverter Abnormal",
"units": "--",
"type": "Double",
"domainPoint": "SITE.InvState.Abnormal"
},
{
"description": "Site POA",
"units": "W/m²",
"type": "Double",
"domainPoint": "SITE.Radiation"
}
],
"status": 0,
"msg": "success"
}