DriveMotionUsers
Common API Objects
Common Response
| Attribute |
Type |
Default |
Required |
Description |
| status |
ResponseStatus |
|
Yes |
Response Status Enum |
| message |
String |
|
No |
|
| t |
T |
|
No |
Data Object |
ResponseStatus
| Code |
Name |
| 32200 |
SUCCESS |
| 32400 |
INVALID_REQUEST |
| 32500 |
INTERNAL_SERVER_ERROR |
Get User Profiles
GetUserProfileResponse
| Attribute |
Type |
Default |
Required |
Description |
| userProfile |
UserProfile |
|
No |
User profile info |
UserProfile
| Attribute |
Type |
Default |
Required |
Description |
| userId |
String |
|
Yes |
User ID |
| telematicsUserId |
String |
|
Yes |
Telematics User ID |
| userAlias |
String |
|
Yes |
User Alias |
| userState |
String |
|
Yes |
User State |
| userConsent |
Boolean |
|
Yes |
User Consent |
| premiumScoreVersion |
String |
|
No |
Premium Score Version |
| userConsentTime |
Date |
|
No |
User Consent time |
| vehicleProfiles |
List |
|
No |
User's vehicle profiles |
VehicleProfile
| Attribute |
Type |
Default |
Required |
Description |
| telematicsVehicleId |
String |
|
Yes |
Telematics Vehicle ID |
| telematicsVehicleId |
String |
|
Yes |
Telematics Vehicle ID |
| vehicle |
Vehicle |
|
Yes |
Vehicle Info |
| telematics |
VehicleTelematics |
|
Yes |
Vehicle Telematics Info |
Vehicle
| Attribute |
Type |
Default |
Required |
Description |
| vin |
String |
|
Yes |
Vehicle VIN number |
| licenseState |
String |
|
Yes |
|
| licensePlate |
String |
|
Yes |
|
| make |
String |
|
Yes |
|
| model |
String |
|
Yes |
|
| year |
Integer |
|
Yes |
|
VehicleTelematics
| Attribute |
Type |
Default |
Required |
Description |
| consent |
VehicleConsent |
|
Yes |
|
| channel |
VehicleChannel |
|
Yes |
|
VehicleConsent
| Attribute |
Type |
Default |
Required |
Description |
| status |
Boolean |
|
Yes |
|
| reason |
String |
|
Yes |
|
| timestamp |
Date |
|
No |
|
VehicleChannel
| Attribute |
Type |
Default |
Required |
Description |
| channelId |
String |
|
Yes |
|
| channelClientId |
String |
|
Yes |
|
Opt In
OptInResponse
| Attribute |
Type |
Default |
Required |
Description |
| userProfile |
UserProfile |
|
No |
User profile info |
Opt Out
OptOutResponse
| Attribute |
Type |
Default |
Required |
Description |
| userProfile |
UserProfile |
|
No |
User profile info |
Delete Account And Data
DeleteAccountAndDataResponse
| Attribute |
Type |
Default |
Required |
Description |
| success |
Boolean |
|
Yes |
Is action success or not |