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
PerformAppServiceInteraction
- Type
- Function
- Sender
- SDL / HMI
- Purpose
- Request a service provider to perform a predefined action.
Request
Must
Process serviceUri according to whatever predefined schema is offered by the HMI service
Note
If the HMI is the App Service Consumer (ASC), SDL will:
1. Activate the service specified with serviceID if requestServiceActive is set to true
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| serviceUri | String | true | |
| serviceID | String | true | |
| originApp | String | false | Non-mandatory only if HMI is the ASC |
| requestServiceActive | Boolean | false |
Response
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| serviceSpecificResult | String | false |
Sequence Diagrams
JSON Message Examples
Example Request
{ "id": 1000, "jsonrpc": "2.0", "method": "AppService.PerformAppServiceInteraction", "params": { "serviceUri": "host:sample.service.uri", "serviceID": "service_id", "originApp": "123456" } }
Example Response
{ "id" : 1000, "jsonrpc" : "2.0", "result" : { "serviceSpecificResult" : "QUEUED", "code" : 0, "method" : "AppService.PerformAppServiceInteraction" } }
Example Error
{ "id" : 1000, "jsonrpc" : "2.0", "error" : { "code" : 1, "message" : "No known service interaction matching URI", "data" : { "method" : "AppService.PerformAppServiceInteraction" } } }