API Reference - pims.vehicle.destination-coordinate

Edit

Info: Stellantis Mobile SDK is not publicly available.

Component: 🏁 Send Navigation ^PSA

Tutorial: check-out Send Navigation.

SDK Version: v2.3

API Available since: v2.0

API Last update: v2.3 Updated API!

Plateforme Compatibility: PSA

Security:

Authentication: Authentication is required.

Operations:

SET

pims.vehicle.destination - coordinate

This api allows sending a navigation (using Coordinates) from the mobile phone to the vehicle.

This API is available only if privacy is set to none, check-out pims.vehicle.privacy.

Input Parameters Object
Param name	Description	Type	Unit/Values	Example	Required
action	Name of the action to perform, in this case `coordinate`.	String	`coordinate`	`coordinate`	`true`
preserve	If this parameter is true, the navigation will be send as soon as the vehicle is connected. Otherwise it will only try once.	Boolean	`n/a`	`true`	`true`
location	Destination Location.	Object	/	/
location .latitude	latitude value	Double	`n/a`	`48.77232`	`true`
location .longitude	longitude value	Double	`n/a`	`2.2151043`	`true`

Output Data Object
Data name	Description	Type	Unit/Values	Example
status	Indicates the status of request.	Enum of Strings	`- notAvailable` `- sent` `- stored`	`sent`
reason	Description of the failure reason.	String	`- GEOLOC_PRIVATE` `- FULL_PRIVATE`	`GEOLOC_PRIVATE`

Error
No errors

Code Example

          
              
                
              
              Request Kotlin
            

              
                
              
              Request Swift
            

        
pims.set("pims.vehicle.destination",
  mapOf( /* parameters */  
    Pair("action", "coordinate"),
    Pair("preserve", true),
    Pair("location", )
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
pims.set(api: "pims.vehicle.destination",
  parameters: [  
    "action": "coordinate",
    "preserve": true,
    "location": 
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "status": "sent",
    "reason": "GEOLOC_PRIVATE"
  }
}

false

Mobile SDK

iOS or Android

API Reference - pims.vehicle.destination-coordinate