Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

GetPolicyConfigurationData

Type
Function
Sender
HMI
Purpose
To get a specific field from the policy table

Request

Must
  1. Send GetPolicyConfigurationData request to SDL with:
    • policyType : Policy Struct for which property needs to be read. Must be a valid policyType struct
    • property: Used to request a specific property of policyType.

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 true 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 url version for custom_vehicle_data_mapping_url from returned json

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"
        }
    }
}
View on GitHub.com
Previous Section Next Section