API Reference - pims.subscription.vehicle-removeProperty
Info: Stellantis Mobile SDK is not publicly available.
Component:
👤
User Information
PSA
Tutorial:
check-out
User Information.
SDK Version:
v2.3
API Available since:
v2.1
API Last update:
v2.1
Plateforme Compatibility: PSA
Security:
- Authentication: Authentication is required.
Operations:
Delete the vehicle from the user account (for example when the vehicle is sold).
Input Parameters Object | |||||
---|---|---|---|---|---|
Param name | Description | Type | Unit/Values | Example | Required |
action | Action Name, in this case |
String |
|
removeProperty
|
true |
vin | Vehicle Identification Number |
String |
|
VR1AB12C3D4567890
|
true |
Output Data Object | ||||
---|---|---|---|---|
No outputted data |
Error | ||
---|---|---|
No errors |
Code Example
1
2
3
4
5
6
7
8
9
10
pims.set("pims.subscription.vehicle",
mapOf( /* parameters */
Pair("action", "removeProperty"),
Pair("vin", "VR1AB12C3D4567890")
)
) { message -> when (message["status"] as? String) {
"SUCCEEDED" -> { } // handle succeeded status
"FAILED" -> { } // handle failed status
} }
1
2
3
4
5
6
7
8
9
10
pims.set(api: "pims.subscription.vehicle",
parameters: [
"action": "removeProperty",
"vin": "VR1AB12C3D4567890"
]
) { (message) in
if message["status"] == "SUCCEEDED" { } // handle succeeded status
else if message["status"] == "FAILED" { } // handle failed status
}
1
2
3
4
5
6
// representation of the `succeeded` dictionary object message as JSON
{
"transactionId": "953cfefb-bc72",
"status": "SUCCEEDED",
"result": { }
}
false