Connection status
This endpoint can be used to retrieve the status of the connection of a user with a portal
Reference
GET /connectionstatus/<userId>[/<portal>]
Retrieve the current connection status
Fields result
field | type | description/constraints | Req | W | U |
---|---|---|---|---|---|
userId | int | Yes | No | No | |
portal | string | Available options:
|
Yes | No | No |
status | boolean | Overall status of the connection | Yes | No | No |
externalUserId | int | No | No | No | |
accessToken | string | The accesstoken | No | No | No |
accessTokenExpire | date | The date/time when the access token will expire | No | No | No |
refreshToken | string | The refresh token | No | No | No |
string | The e-mail address of the account on the portal site used for authentication. | No | No | No | |
scope | array | A list of scopes associated with this token | No | No | No |
Example retrieving connection status
Request
GET /rest/v1/connectionstatus/12311/marktplaats HTTP/2
Response
{
"result": true,
"errors": [],
"data": {
"userId": 12311,
"portal": "marktplaats",
"status": false,
"externalUserId": 0,
"accessToken": "3ed34b28-78eb-424f-9ed3-40cf7e2b3152",
"accessTokenExpire": "2021-06-10 10:26:30",
"refreshToken": "0743f965-a26f-4904-aa26-58f49787c8a6",
"email": "",
"scope": [
"write",
"fitments",
"car_attributes_editable",
"update_category",
"dealer_video",
"extended_sellername",
"tenant_mp",
"outlet",
"reviews",
"invoice_allowed",
"read",
"update_nap",
"branding"
]
}
}