This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
To Top
To Bottom
GetPolicyConfigurationData
- Type
- Function
- Sender
- HMI
- Purpose
- To get a specific field from the policy table
Request
Must
- Send GetPolicyConfigurationData request to SDL with:
policyType: Policy Struct for which property needs to be read. Must be a valid policyType structproperty: Used to request a specific property ofpolicyType.
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| policyType | String | true | minlength: 1 maxlength: 1000 |
| property | String | true | minlength: 1 maxlength: 1000 |
Response
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| value | String | false | array: true maxlength: 1000 minsize: 1 maxsize: 100 |
Sequence Diagrams
Below is the example usage for GetPolicyConfigurationData request to read version and endpoint url for custom_vehicle_data_mapping_url
- HMI needs to parse the
urlversion forcustom_vehicle_data_mapping_urlfrom returned json
JSON Message Examples
Example Request
{ "id" : 176, "jsonrpc" : "2.0", "method" : "SDL.GetPolicyConfigurationData", "params" : { "policyType": "module_config", "property" : "endpoints_properties" } }
Example Response
{ "id" : 176, "jsonrpc" : "2.0", "result" : { "value" : [ "{\"custom_vehicle_data_mapping_url\":{\"version\":\"0.0.0\"}}" ], "code" : 0, "method" : "SDL.GetPolicyConfigurationData" } }
Example Error
{ "id" : 176, "jsonrpc" : "2.0", "error" : { "code" : 11, "message" : "Invalid data", "data" : { "method" : "SDL.GetPolicyConfigurationData" } } }