API Reference - technical.userId
This access the user identifier (user ID) sent by the smartdevice..
Note: In order for this API to work as intended, the smartdevice shall initially authentified the user and retrieved its unique identifier from offboard Stellantis database. This API gives access to the result of this authentication process done by the smartdevice itself (mostly but not only, by a mobile phone application).
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| userId | User identifier (user ID) sent by the smartdevice. |
string |
|
7473a16f-9f4f-46c9-85a7-5291e35f1ba0
|
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"technical.userId",
/* parameters */
null
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "GET",
"api": "technical.userId",
"params": null
}
1
2
3
4
5
6
7
8
9
10
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "technical.userId",
"status": 200,
"statusText": "OK",
"data": "7473a16f-9f4f-46c9-85a7-5291e35f1ba0"
}
false
This access the user identifier (user ID) sent by the smartdevice..
Note: In order for this API to work as intended, the smartdevice shall initially authentified the user and retrieved its unique identifier from offboard Stellantis database. This API gives access to the result of this authentication process done by the smartdevice itself (mostly but not only, by a mobile phone application).
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| userId | User identifier (user ID) sent by the smartdevice. |
string |
|
7473a16f-9f4f-46c9-85a7-5291e35f1ba0
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
/* api name */
"technical.userId",
/* parameters */
null,
/* callback for `NOTIFY` messages */
async (notifyMessage) => {
if (notifyMessage.status === 200) {
/* handle `NOTIFY` response */
}
else { /* handle `NOTIFY` error */ }
}
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "SUBSCRIBE",
"api": "technical.userId",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"status": 200,
"statusText": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "NOTIFY",
"api": "technical.userId",
"status": 200,
"statusText": "OK",
"data": "7473a16f-9f4f-46c9-85a7-5291e35f1ba0"
}