ASSOCIATION-API (1)

Download OpenAPI specification:

This provides association-api services

association-controller

PUT v1/user/device/vin

association-controller-associateVin

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

vin required	string
imei required	string
region	string

Responses

Request samples

Payload

Content type

application/json

{"vin": "string",
"imei": "string",
"region": "string"
}

PUT v1/devices/item

association-controller-saveDeviceItem

SCOPE: [IgniteSystem]

Authorizations:

None

header Parameters

correlationId

string

Request Body schema: application/json
required

Array of objects (DeviceItems)

Responses

Request samples

Payload

Content type

application/json

{"data": [{"deviceId": "string",
"items": [{"name": "string",
"value": { }
}
]
}
]
}

POST v3/user/devices/associate/

association-controller-associateDevice

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

Request Body schema: application/json
required

userId	string
serialNumber	string
imei	string
imsi	string
ssid	string
iccid	string
msisdn	string
bssid	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"serialNumber": "string",
"imei": "string",
"imsi": "string",
"ssid": "string",
"iccid": "string",
"msisdn": "string",
"bssid": "string"
}

POST v2/user/associations/terminate

association-controller-terminateAssociation

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage,IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

associationId	integer <int64>
deviceId	string
serialNumber	string
imei	string
userId	string
requiredFor	string

Responses

Request samples

Payload

Content type

application/json

{"associationId": 0,
"deviceId": "string",
"serialNumber": "string",
"imei": "string",
"userId": "string",
"requiredFor": "string"
}

POST v1/user/associations/wipe

association-controller-wipeDevices

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json

serialNumber

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"serialNumber": ["string"
]
}

POST v1/sim/suspend

association-controller-suspendSim

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage,IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

imei

required

string

Responses

Request samples

Payload

Content type

application/json

{"imei": "string"
}

POST /v1/associations

association-controller-delegateAssociationByAdmin

SCOPE: [IgniteSystem]

Authorizations:

None

header Parameters

correlationId

required

string

Request Body schema: application/json
required

serialNumber	string
imei	string
imsi	string
ssid	string
iccid	string
msisdn	string
bssid	string
associationType required	string
delegationUserId	string
email	string
startTimestamp	integer <int64>
endTimestamp	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"serialNumber": "string",
"imei": "string",
"imsi": "string",
"ssid": "string",
"iccid": "string",
"msisdn": "string",
"bssid": "string",
"associationType": "string",
"delegationUserId": "string",
"email": "string",
"startTimestamp": 0,
"endTimestamp": 0
}

POST /v1/associations/terminate

association-controller-terminateM2Massociation

SCOPE: [SelfManage,IgniteSystem]

Authorizations:

None

header Parameters

user-id required	string
admin-user-id	string Default: notAdmin
isAdmin	boolean Default: false
correlationId required	string

Request Body schema: application/json
required

associationId	integer <int64>
deviceId	string
serialNumber	string
imei	string
userId	string
requiredFor	string

Responses

Request samples

Payload

Content type

application/json

{"associationId": 0,
"deviceId": "string",
"serialNumber": "string",
"imei": "string",
"userId": "string",
"requiredFor": "string"
}

POST v1/associations/self

association-controller-associateDeviceForSelf

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

header Parameters

user-id required	string
correlationId required	string

Request Body schema: application/json
required

userId	string
serialNumber	string
imei	string
imsi	string
ssid	string
iccid	string
msisdn	string
bssid	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"serialNumber": "string",
"imei": "string",
"imsi": "string",
"ssid": "string",
"iccid": "string",
"msisdn": "string",
"bssid": "string"
}

POST /v1/associations/self/terminate

association-controller-terminateM2MselfAssociation

SCOPE: [SelfManage]

Authorizations:

None

header Parameters

user-id required	string
correlationId required	string

Request Body schema: application/json
required

associationId	integer <int64>
deviceId	string
serialNumber	string
imei	string
userId	string
requiredFor	string

Responses

Request samples

Payload

Content type

application/json

{"associationId": 0,
"deviceId": "string",
"serialNumber": "string",
"imei": "string",
"userId": "string",
"requiredFor": "string"
}

POST /v1/associations/delegation

association-controller-delegateAssociation

SCOPE: [SelfManage]

Authorizations:

None

header Parameters

correlationId

required

string

Request Body schema: application/json
required

serialNumber	string
imei	string
imsi	string
ssid	string
iccid	string
msisdn	string
bssid	string
associationType required	string
delegationUserId	string
email	string
startTimestamp	integer <int64>
endTimestamp	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"serialNumber": "string",
"imei": "string",
"imsi": "string",
"ssid": "string",
"iccid": "string",
"msisdn": "string",
"bssid": "string",
"associationType": "string",
"delegationUserId": "string",
"email": "string",
"startTimestamp": 0,
"endTimestamp": 0
}

GET v3/user/associations/

association-controller-findAssociation

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage,IgniteSystem]

Authorizations:

None

Responses

device-association-rest-service

PUT /v1/user/device/state

device-association-rest-service-changeState

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

state required	string
imei	string
deviceId	string
userId	string

Responses

Request samples

Payload

Content type

application/json

{"state": "string",
"imei": "string",
"deviceId": "string",
"userId": "string"
}

POST v2/user/devices/associate/

device-association-rest-service-associateDeviceWithFactoryData

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

Request Body schema: application/json
required

userId	string
serialNumber	string
imei	string
imsi	string
ssid	string
iccid	string
msisdn	string
bssid	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"serialNumber": "string",
"imei": "string",
"imsi": "string",
"ssid": "string",
"iccid": "string",
"msisdn": "string",
"bssid": "string"
}

POST v1/user/devices/associate/

device-association-rest-service-associateDevice

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

Request Body schema: application/json
required

userId	string
serialNumber	string
imei	string
imsi	string
ssid	string
iccid	string
msisdn	string
bssid	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"serialNumber": "string",
"imei": "string",
"imsi": "string",
"ssid": "string",
"iccid": "string",
"msisdn": "string",
"bssid": "string"
}

POST /v1/user/device/replace

device-association-rest-service-replaceDevice

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage,IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

serialNumber	string
	object (CurrentDeviceDataPojo)
	object (ReplaceDeviceDataPojo)

Responses

Request samples

Payload

Content type

application/json

{"serialNumber": "string",
"currentValue": {"imei": "string",
"serialNumber": "string",
"iccid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"state": "string"
},
"replaceWith": {"manufacturingDate": "string",
"model": "string",
"imei": "string",
"serialNumber": "string",
"platformVersion": "string",
"iccid": "string",
"ssid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"recordDate": "string",
"packageSerialNumber": "string",
"vin": "string",
"chassisNumber": "string",
"state": "string",
"plant": "string",
"productionWeek": "string",
"vehicleModelYear": "string",
"friendlyName": "string"
}
}

POST v1/user/associations/terminate

device-association-rest-service-terminateAssociation

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage,IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

associationId	integer <int64>
deviceId	string
serialNumber	string
imei	string
userId	string
requiredFor	string

Responses

Request samples

Payload

Content type

application/json

{"associationId": 0,
"deviceId": "string",
"serialNumber": "string",
"imei": "string",
"userId": "string",
"requiredFor": "string"
}

POST /v1/user/associations/suspend

device-association-rest-service-suspendDevice

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

associationId	integer <int64>
deviceId	string
serialNumber	string
imei	string
userId	string
requiredFor	string

Responses

Request samples

Payload

Content type

application/json

{"associationId": 0,
"deviceId": "string",
"serialNumber": "string",
"imei": "string",
"userId": "string",
"requiredFor": "string"
}

POST v1/user/associations/restore

device-association-rest-service-restoreAssociation

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

associationId	integer <int64>
deviceId	string
serialNumber	string
imei	string
userId	string
requiredFor	string

Responses

Request samples

Payload

Content type

application/json

{"associationId": 0,
"deviceId": "string",
"serialNumber": "string",
"imei": "string",
"userId": "string",
"requiredFor": "string"
}

GET v2/user/associations/

device-association-rest-service-associatedDevicesOfUserWithFactoryData

SCOPE: [SelfManage,Dongle,DEFAULT]

Authorizations:

None

Responses

GET /v1/users/association/details

device-association-rest-service-getAssociationDetails

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

query Parameters

imei	string Default: ""
serialnumber	string Default: ""
deviceid	string Default: ""

Responses

GET v1/user/associations/{associationID}

device-association-rest-service-getAssociationDetails

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

path Parameters

associationID

required

integer <int64>

Responses

GET v1/user/associations/

device-association-rest-service-associatedDevicesOfUser

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

Responses

GET v1/devices/{serialNumber}/associated

device-association-rest-service-isDeviceAlreadyAssociated

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

path Parameters

serialNumber

required

string

Responses

GET v1/devices/{imei}/association/history

device-association-rest-service-getAssociationHistory

SCOPE: [IgniteSystem,userOrThirdPartyToken]

Authorizations:

None

path Parameters

imei

required

string

query Parameters

page	string Default: "1"
size	string Default: "20"
sortby	string Default: ""
orderby	string Default: ""

Responses

GET v1/associationdetails

device-association-rest-service-getDeviceAssociationDetails

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

userId

string

Default: ""

Responses

m-2-massociation-controller

PATCH /v1/self/associations/{associationId}

m-2-massociation-controller-updateAssociation

SCOPE: [AssociateMyselfToVehicle,UserDeviceAssocn,SelfManage]

Authorizations:

None

path Parameters

associationId

required

integer <int64>

header Parameters

correlationId required	string
user-id required	string

Request Body schema: application/json
required

assocType	string
startTime	integer <int64>
endTime	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"assocType": "string",
"startTime": 0,
"endTime": 0
}

device-authentication-controller

POST /v4/device/activate/

device-authentication-controller-activateV4

WARNING!! - Security Config Not Found

Request Body schema: application/json
required

vin required	string
serialNumber required	string
qualifier required	string
productType required	string
deviceType required	string
ssid	string
SW-Version required	string
HW-Version required	string
imei	string
iccid	string
msisdn	string
imsi	string
bssid	string
aad	string

Responses

Request samples

Payload

Content type

application/json

{"vin": "string",
"serialNumber": "string",
"qualifier": "string",
"productType": "string",
"deviceType": "string",
"ssid": "string",
"SW-Version": "string",
"HW-Version": "string",
"imei": "string",
"iccid": "string",
"msisdn": "string",
"imsi": "string",
"bssid": "string",
"aad": "string"
}

POST /v3/device/activate/

device-authentication-controller-activateV3

WARNING!! - Security Config Not Found

Request Body schema: application/json
required

vin required	string
serialNumber required	string
qualifier required	string
productType required	string
deviceType required	string
ssid	string
SW-Version required	string
HW-Version required	string
imei	string
iccid	string
msisdn	string
imsi	string
bssid	string
aad	string

Responses

Request samples

Payload

Content type

application/json

{"vin": "string",
"serialNumber": "string",
"qualifier": "string",
"productType": "string",
"deviceType": "string",
"ssid": "string",
"SW-Version": "string",
"HW-Version": "string",
"imei": "string",
"iccid": "string",
"msisdn": "string",
"imsi": "string",
"bssid": "string",
"aad": "string"
}

authentication-rest-service

POST /v2/device/deactivate

authentication-rest-service-deviceDeactivate

WARNING!! - Security Config Not Found

header Parameters

user-id

required

string

Request Body schema: application/json
required

factoryId

required

string

Responses

Request samples

Payload

Content type

application/json

{"factoryId": "string"
}

POST /v2/device/activate/

authentication-rest-service-activateV2

WARNING!! - Security Config Not Found

Request Body schema: application/json
required

vin required	string
serialNumber required	string
qualifier required	string
productType required	string
deviceType required	string
ssid	string
SW-Version required	string
HW-Version required	string
imei	string
iccid	string
msisdn	string
imsi	string
bssid	string
aad	string

Responses

Request samples

Payload

Content type

application/json

{"vin": "string",
"serialNumber": "string",
"qualifier": "string",
"productType": "string",
"deviceType": "string",
"ssid": "string",
"SW-Version": "string",
"HW-Version": "string",
"imei": "string",
"iccid": "string",
"msisdn": "string",
"imsi": "string",
"bssid": "string",
"aad": "string"
}

POST /device/setReadyToActivate

authentication-rest-service-setReadyToActivate

WARNING!! - Security Config Not Found

Request Body schema: application/json
required

serialNumber

string

Responses

Request samples

Payload

Content type

application/json

{"serialNumber": "string"
}

device-controller

PUT /v1/devices/update

device-controller-updateDevice

SCOPE: [IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

	object (DeviceData)
	object (DeviceData)

Responses

Request samples

Payload

Content type

application/json

{"currentValue": {"factoryAdmin": "string",
"manufacturingDate": "string",
"model": "string",
"imei": "string",
"serialNumber": "string",
"platformVersion": "string",
"iccid": "string",
"ssid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"recordDate": "string",
"packageSerialNumber": "string",
"chassisNumber": "string",
"plant": "string",
"productionWeek": "string",
"vehicleModelYear": "string",
"vin": "string",
"friendlyName": "string"
},
"replaceWith": {"factoryAdmin": "string",
"manufacturingDate": "string",
"model": "string",
"imei": "string",
"serialNumber": "string",
"platformVersion": "string",
"iccid": "string",
"ssid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"recordDate": "string",
"packageSerialNumber": "string",
"chassisNumber": "string",
"plant": "string",
"productionWeek": "string",
"vehicleModelYear": "string",
"vin": "string",
"friendlyName": "string"
}
}

PUT /v1/devices/state

device-controller-changeDeviceState

SCOPE: [IgniteSystem]

Authorizations:

None

Request Body schema: application/json
required

factoryId required	integer <int64>
state required	string Enum: "PROVISIONED" "READY_TO_ACTIVATE" "ACTIVE" "STOLEN" "FAULTY" "DEACTIVATED" "PROVISIONED_ALIVE"
imei	string

Responses

Request samples

Payload

Content type

application/json

{"factoryId": 0,
"state": "PROVISIONED",
"imei": "string"
}

POST /v3/devices/create

device-controller-createDevicesV3

SCOPE: [IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

Array

manufacturingDate required	string
model required	string
imei	string
serialNumber required	string
platformVersion	string
iccid	string
ssid	string
bssid	string
msisdn	string
imsi	string
recordDate required	string
packageSerialNumber	string
vin	string
chassisNumber	string
plant	string
productionWeek	string
vehicleModelYear	string
friendlyName	string
deviceType	string
region	string

Responses

Request samples

Payload

Content type

application/json

[{"manufacturingDate": "string",
"model": "string",
"imei": "string",
"serialNumber": "string",
"platformVersion": "string",
"iccid": "string",
"ssid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"recordDate": "string",
"packageSerialNumber": "string",
"vin": "string",
"chassisNumber": "string",
"plant": "string",
"productionWeek": "string",
"vehicleModelYear": "string",
"friendlyName": "string",
"deviceType": "string",
"region": "string"
}
]

POST /v2/devices/create

device-controller-createDevicesV2

SCOPE: [IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

Array

manufacturingDate required	string
model required	string
imei	string
serialNumber required	string
platformVersion	string
iccid	string
ssid	string
bssid	string
msisdn	string
imsi	string
recordDate required	string
packageSerialNumber	string
vin	string
chassisNumber	string
plant	string
productionWeek	string
vehicleModelYear	string
friendlyName	string
deviceType	string
region	string

Responses

Request samples

Payload

Content type

application/json

[{"manufacturingDate": "string",
"model": "string",
"imei": "string",
"serialNumber": "string",
"platformVersion": "string",
"iccid": "string",
"ssid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"recordDate": "string",
"packageSerialNumber": "string",
"vin": "string",
"chassisNumber": "string",
"plant": "string",
"productionWeek": "string",
"vehicleModelYear": "string",
"friendlyName": "string",
"deviceType": "string",
"region": "string"
}
]

POST /v1/devices/create

device-controller-addDevices

SCOPE: [IgniteSystem]

Authorizations:

None

header Parameters

user-id

required

string

Request Body schema: application/json
required

Array

manufacturingDate required	string
model required	string
imei	string
serialNumber required	string
platformVersion	string
iccid	string
ssid	string
bssid	string
msisdn	string
imsi	string
recordDate required	string
packageSerialNumber	string
vin	string
chassisNumber	string
plant	string
productionWeek	string
vehicleModelYear	string
friendlyName	string

Responses

Request samples

Payload

Content type

application/json

[{"manufacturingDate": "string",
"model": "string",
"imei": "string",
"serialNumber": "string",
"platformVersion": "string",
"iccid": "string",
"ssid": "string",
"bssid": "string",
"msisdn": "string",
"imsi": "string",
"recordDate": "string",
"packageSerialNumber": "string",
"vin": "string",
"chassisNumber": "string",
"plant": "string",
"productionWeek": "string",
"vehicleModelYear": "string",
"friendlyName": "string"
}
]

GET /v5/devices/details

device-controller-getAllFactoryDataWithSubscriptionStatus

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

imei	string^[0-9]*$
size	string Default: ""
page	string Default: ""
serialnumber	string Default: ""
deviceid	string Default: ""
vin	string Default: ""
sortby	string Default: "imei"
orderby	string Default: "desc"
state	string Default: ""

Responses

GET /v4/devices/details

device-controller-getAllFactoryData

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

imei	string^[0-9]*$
size	string Default: ""
page	string Default: ""
sortby	string Default: "imei"
orderby	string Default: "desc"

Responses

GET v3/devices/details

device-controller-getAllFactoryDataV3

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

isdetailsrequired required	string Enum: "true" "false"
sortingorder required	string Enum: "asc" "desc"
size	string Default: ""
page	string Default: ""
containslikefields	string Default: ""
containslikevalues	string Default: ""
sortby	string Default: ""
rangefields	string Default: ""
rangevalues	string Default: ""

Responses

GET v2/devices/details

device-controller-getAllFactoryData

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

isdetailsrequired required	string Enum: "true" "false"
size	string Default: ""
page	string Default: ""
asc	string Default: ""
desc	string Default: ""
imei	string^[0-9]*$
serialnumber	string^[0-9a-zA-Z]*$

Responses

GET v1/devices/{imei}/states

device-controller-findAllDeviceStates

SCOPE: [IgniteSystem]

Authorizations:

None

path Parameters

imei

required

string

query Parameters

orderby	string Enum: "asc" "desc"
size	string Default: ""
page	string Default: ""
sortby	string Default: ""

Responses

GET /v1/devices/details

device-controller-findFactoryData

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

imei	string^[0-9]*$
serialnumber	string^[0-9a-zA-Z]*$
ssid	string^[0-9a-zA-Z]*$
iccid	string^[0-9a-zA-Z]*$
msisdn	string^[0-9]*$
imsi	string^[0-9a-zA-Z]*$
bssid	string^[0-9a-zA-Z:]*$
packageserialnumber	string^[0-9a-zA-Z]*$

Responses

DELETE /v1/devices/details

device-controller-deleteDevice

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

imei	string Default: ""
serialnumber	string Default: ""

header Parameters

user-id

required

string

Responses

device-message-controller

POST /{version}/devices/{deviceId}/config

API used to send messages to MQTT
device-message-controller-publishMessage

SCOPE: [DeviceMessaging]

Authorizations:

None

path Parameters

device_id required	string[a-zA-Z0-9]+
version required	string^v1$

Request Body schema: application/json
required

data	object
domain	string
version	string
command	string
timestamp	integer <int64>
requestId	string
bizTransactionId	string

Responses

Request samples

Payload

Content type

application/json

{"data": { },
"domain": "string",
"version": "string",
"command": "string",
"timestamp": 0,
"requestId": "string",
"bizTransactionId": "string"
}

Response samples

200

Content type

application/json

[{"data": { },
"domain": "string",
"version": "string",
"command": "string",
"timestamp": 0,
"requestId": "string",
"bizTransactionId": "string"
}
]

device-configuration-controller

GET /{apiVersion}/devices/{deviceId}/configuration

Fetch configuration request sent by Device-Message
device-configuration-controller-getConfigurationV1

SCOPE: [dongle,hu,tcu,Dongle,dashcam]

Authorizations:

None

path Parameters

apiVersion required	string^v1$
deviceId required	string[a-zA-Z0-9]+

query Parameters

since

required

string\d+

Responses

Response samples

200

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"pdid": "string",
"uploadTimeStamp": 0,
"payload": {"property1": { },
"property2": { }
},
"deleted": true,
"schemaVersion": "1.0"
}
]

notification-config-controller

Update secondary contact

Update secondary contact
notification-config-controller-updateContact

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
contactId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

lastUpdatedTime	string <date-time>
contactId	string
userId	string
contactName required	string
required	object
email	string
phoneNumber	string
vehicleId	string
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"

Responses

Request samples

Payload

Content type

application/json

{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"contactId": "string",
"userId": "string",
"contactName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"email": "string",
"phoneNumber": "string",
"vehicleId": "string",
"schemaVersion": "1.0"
}

Response samples

200

Content type

application/json

{"contactId": "string",
"message": "string"
}

Delete secondary contact

Delete secondary contact
notification-config-controller-deleteContact

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
contactId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Create secondary contact

Create secondary contact
notification-config-controller-createContact

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

lastUpdatedTime	string <date-time>
contactId	string
userId	string
contactName required	string
required	object
email	string
phoneNumber	string
vehicleId	string
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"

Responses

Request samples

Payload

Content type

application/json

{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"contactId": "string",
"userId": "string",
"contactName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"email": "string",
"phoneNumber": "string",
"vehicleId": "string",
"schemaVersion": "1.0"
}

Response samples

200

Content type

application/json

{"contactId": "string",
"message": "string"
}

Upload notification template config

Upload notification template config
notification-config-controller-postNotificationTemplateConfig

SCOPE: [ManageNotifications]

Authorizations:

None

Request Body schema: application/json
required

Array

lastUpdatedTime	string <date-time>
notificationId	string
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"
	object
	object (EmailConfig)
	object (SmsConfig)
	object (IvmConfig)

Responses

Request samples

Payload

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"notificationId": "string",
"schemaVersion": "1.0",
"apiPush": {"property1": { },
"property2": { }
},
"email": {"contentType": "string"
},
"sms": {"smsType": "string"
},
"ivm": {"sendAllLanguages": true
}
}
]

Upload notification grouping

Upload notification grouping
notification-config-controller-postNotificationGrouping

SCOPE: [ManageNotifications]

Authorizations:

None

Request Body schema: application/json
required

Array

lastUpdatedTime	string <date-time>
id	string
notificationId	string
group	string
mandatory	boolean
service	string
checkEntitlement	boolean
groupType	string Enum: "DEFAULT" "USER_ONLY" "USER_VEHICLE"
checkAssociation	boolean
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"

Responses

Request samples

Payload

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"notificationId": "string",
"group": "string",
"mandatory": true,
"service": "string",
"checkEntitlement": true,
"groupType": "DEFAULT",
"checkAssociation": true,
"schemaVersion": "1.0"
}
]

Upload default template

Upload default template
notification-config-controller-postNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

Request Body schema: application/json
required

Array

lastUpdatedTime	string <date-time>
id	string
notificationId	string
notificationShortName	string
notificationLongName	string
	object
brand	string
customPlaceholders	Array of strings unique
	object (ChannelTemplates)
	Array of objects (AdditionalLookupProperty)
	object
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"

Responses

Request samples

Payload

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"notificationId": "string",
"notificationShortName": "string",
"notificationLongName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"brand": "string",
"customPlaceholders": ["string"
],
"channelTemplates": {"push": {"title": "string",
"subtitle": "string",
"body": "string",
"contentFieldsGetter": {"property1": { },
"property2": { }
},
"contentFieldsSetter": {"property1": { },
"property2": { }
},
"image": "string"
},
"apiPush": {"title": "string",
"subtitle": "string",
"body": "string",
"contentFieldsGetter": {"property1": { },
"property2": { }
},
"contentFieldsSetter": {"property1": { },
"property2": { }
},
"category": "string",
"bannertitle": "string",
"bannerdesc": "string"
},
"email": {"title": "string",
"subtitle": "string",
"body": "string",
"contentFieldsGetter": {"property1": { },
"property2": { }
},
"contentFieldsSetter": {"property1": { },
"property2": { }
},
"from": "string",
"subject": "string"
},
"sms": {"title": "string",
"subtitle": "string",
"body": "string",
"contentFieldsGetter": {"property1": { },
"property2": { }
},
"contentFieldsSetter": {"property1": { },
"property2": { }
},
"sender": "string"
},
"ivm": {"title": "string",
"subtitle": "string",
"body": "string",
"contentFieldsGetter": {"property1": { },
"property2": { }
},
"contentFieldsSetter": {"property1": { },
"property2": { }
}
},
"portal": {"title": "string",
"subtitle": "string",
"body": "string",
"contentFieldsGetter": {"property1": { },
"property2": { }
},
"contentFieldsSetter": {"property1": { },
"property2": { }
}
}
},
"additionalLookupProperties": [{"name": "string",
"values": ["string"
],
"order": 0
}
],
"localeAsLocale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"schemaVersion": "1.0"
}
]

Delete config for self or secondary contact

Delete config for self or secondary contact
notification-config-controller-deleteContact

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string
contactId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Create\Update notification configuration of a contact

Create\Update notification configuration of a contact
notification-config-controller-updateNotificationConfig

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string
contactId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

Array

group required	string
enabled required	boolean
required	Array of ApiPushChannel (object) or EmailChannel (object) or IVMChannel (object) or PortalChannel (object) or PushChannel (object) or SmsChannel (object)
brand	string

Responses

Request samples

Payload

Content type

application/json

[{"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"brand": "string"
}
]

Response samples

200

Content type

text/plain

No sample

Patch user profile

Patch user profile
notification-config-controller-updateUserProfile

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

lastUpdatedTime	string <date-time>
userId	string
firstName required	string
lastName	string
required	object
defaultEmail required	string
defaultPhoneNumber required	string
consent	boolean
	Array of objects (NickName) unique
timeZone	string
lastModifiedTime	integer <int64>
	object
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"

Responses

Request samples

Payload

Content type

application/json

{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"userId": "string",
"firstName": "string",
"lastName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"defaultEmail": "string",
"defaultPhoneNumber": "string",
"consent": true,
"nickNames": [{"nickName": "string",
"vehicleId": "string"
}
],
"timeZone": "string",
"lastModifiedTime": 0,
"customAttributes": {"property1": { },
"property2": { }
},
"schemaVersion": "1.0"
}

Get notification configuration for a user

Get notification configuration for a user
notification-config-controller-getUserNotificationConfig

SCOPE: [SelfManage]

Authorizations:

None

path Parameters

userId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

[{"contactId": "string",
"email": "string",
"phoneNumber": "string",
"contactName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"preferences": [{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"userId": "string",
"vehicleId": "string",
"contactId": "string",
"email": "string",
"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"locale": "string",
"brand": "string",
"schemaVersion": "1.0"
}
]
}
]

Create \update user config

Create \update user config
notification-config-controller-createUserNotificationConfig

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

Array

group required	string
enabled required	boolean
required	Array of ApiPushChannel (object) or EmailChannel (object) or IVMChannel (object) or PortalChannel (object) or PushChannel (object) or SmsChannel (object)
brand	string

Responses

Request samples

Payload

Content type

application/json

[{"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"brand": "string"
}
]

Response samples

200

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"userId": "string",
"vehicleId": "string",
"contactId": "string",
"email": "string",
"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"locale": "string",
"brand": "string",
"schemaVersion": "1.0"
}
]

Create default notification channel config

Create default notification channel config
notification-config-controller-createDefaultNotificationConfig

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

Array

group required	string
enabled required	boolean
required	Array of ApiPushChannel (object) or EmailChannel (object) or IVMChannel (object) or PortalChannel (object) or PushChannel (object) or SmsChannel (object)
brand	string

Responses

Request samples

Payload

Content type

application/json

[{"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"brand": "string"
}
]

Get notification configuration with service

Get notification configuration with service
notification-config-controller-getNotificationConfigOfService

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string
serviceName required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

[{"contactId": "string",
"email": "string",
"phoneNumber": "string",
"contactName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"preferences": [{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"userId": "string",
"vehicleId": "string",
"contactId": "string",
"email": "string",
"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"locale": "string",
"brand": "string",
"schemaVersion": "1.0"
}
]
}
]

Get notification configuration

Get notification configuration
notification-config-controller-getNotificationConfig

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

[{"contactId": "string",
"email": "string",
"phoneNumber": "string",
"contactName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"preferences": [{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"userId": "string",
"vehicleId": "string",
"contactId": "string",
"email": "string",
"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"locale": "string",
"brand": "string",
"schemaVersion": "1.0"
}
]
}
]

Get default notification channel config

Get default notification channel config
notification-config-controller-getDefaultConfig

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

notificationId

required

string

query Parameters

brand

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"userId": "string",
"vehicleId": "string",
"contactId": "string",
"email": "string",
"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"locale": "string",
"brand": "string",
"schemaVersion": "1.0"
}

Get default notification channel config

Get default notification channel config
notification-config-controller-getAllDefaultConfigs

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

notificationId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"userId": "string",
"vehicleId": "string",
"contactId": "string",
"email": "string",
"group": "string",
"enabled": true,
"channels": [{"type": "string",
"enabled": true,
"suppressionConfigs": [{"suppressionType": "RECURRING",
"days": ["MONDAY"
],
"startTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
],
"locale": "string",
"brand": "string",
"schemaVersion": "1.0"
}
]

Get notification grouping

Get notification grouping
notification-config-controller-getNotificationGrouping

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

group

required

string

Responses

Response samples

200

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"notificationId": "string",
"group": "string",
"mandatory": true,
"service": "string",
"checkEntitlement": true,
"groupType": "DEFAULT",
"checkAssociation": true,
"schemaVersion": "1.0"
}
]

Delete notification grouping

Delete notification grouping
notification-config-controller-deleteNotificationGrouping

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

group required	string
notificationId required	string
service required	string

Responses

Delete notification grouping

Delete notification grouping
notification-config-controller-deleteNotificationGrouping

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

group required	string
notificationId required	string

Responses

mute-vehicle-controller

Add or Update Mute Notification Config

Add or Update Mute Notification Config
mute-vehicle-controller-createMuteConfig

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

vehicleId required	string
groups	Array of strings unique
channels	Array of strings unique Items Enum: "MOBILE_APP_PUSH" "SMS" "EMAIL" "API_PUSH" "IVM" "PORTAL"
startTime	string
endTime	string

Responses

Request samples

Payload

Content type

application/json

{"vehicleId": "string",
"groups": ["string"
],
"channels": ["MOBILE_APP_PUSH"
],
"startTime": "string",
"endTime": "string"
}

Response samples

200

Content type

application/json

{"httpStatusCode": 0,
"requestId": "string",
"code": "string",
"reason": "string",
"msg": "string",
"errors": [{"code": "string",
"reason": "string",
"msg": "string"
}
],
"messageList": [{"code": "string",
"reason": "string",
"msg": "string"
}
],
"count": 0,
"data": [{"vehicleId": "string",
"groups": ["string"
],
"channels": ["MOBILE_APP_PUSH"
],
"startTime": "string",
"endTime": "string"
}
]
}

Get Mute Notification Config for vehicle

Get Mute Notification Config for vehicle
mute-vehicle-controller-findMuteConfig

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Delete Mute Notification Config for vehicle

Delete Mute Notification Config for vehicle
mute-vehicle-controller-deleteMuteConfig

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

alerts-controller

Mark Alert Api is to mark the alerts read or unread

Mark Alert Api is to mark the alerts read or unread
alerts-controller-saveV1

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

Request Body schema: application/json
required

read	Array of strings
unread	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"read": ["string"
],
"unread": ["string"
]
}

AlertHistory Api allows to retrieve historical information

API to get historical information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getAllAlertsBetweenSinceAndUntilV3

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
until required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

Responses

Response samples

200

Content type

application/json

{"alerts": [{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"timestamp": 0,
"processingStatus": {"status": "string",
"errorMessage": "string"
},
"skippedChannels": {"property1": "string",
"property2": "string"
},
"retryRecordList": [{"retryException": "string",
"maxRetryLimit": 0,
"retryCount": 0,
"retryIntervalMs": 0
}
],
"statusHistoryRecordList": [{"time": "2019-08-24T14:15:22Z",
"status": "SCHEDULE_REQUESTED",
"correlationId": "string"
}
],
"schemaVersion": "1.0",
"pdid": "string",
"userId": "string",
"alertType": "string",
"payload": {"EventID": "string",
"Data": {"alertDataProperties": {"property1": { },
"property2": { }
},
"userProfile": {"lastUpdatedTime": "2019-08-24T14:15:22Z",
"userId": "string",
"firstName": "string",
"lastName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"defaultEmail": "string",
"defaultPhoneNumber": "string",
"consent": true,
"nickNames": [{"nickName": "string",
"vehicleId": "string"
}
],
"timeZone": "string",
"lastModifiedTime": 0,
"customAttributes": {"property1": { },
"property2": { }
},
"schemaVersion": "1.0"
},
"vehicleProfile": {"vehicleId": "string",
"vehicleAttributes": {"property1": { },
"property2": { }
},
"vehicleAttributeLog": "string"
},
"notificationId": "string",
"marketingName": "string",
"mqttTopic": "string"
},
"Version": "string",
"BenchMode": 0,
"Timezone": 0,
"Timestamp": 0,
"pdid": "string"
},
"alertMessage": "string",
"read": true,
"deleted": true,
"campaignId": "string"
}
],
"pagination": {"total": {"pages": 0,
"records": 0
},
"size": 0,
"page": 0
}
}

API to retrieve historical information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get historical information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getSpecificAlertBetweenSinceAndUntilV3

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
until required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

Responses

Response samples

200

Content type

application/json

{"alerts": [{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"timestamp": 0,
"processingStatus": {"status": "string",
"errorMessage": "string"
},
"skippedChannels": {"property1": "string",
"property2": "string"
},
"retryRecordList": [{"retryException": "string",
"maxRetryLimit": 0,
"retryCount": 0,
"retryIntervalMs": 0
}
],
"statusHistoryRecordList": [{"time": "2019-08-24T14:15:22Z",
"status": "SCHEDULE_REQUESTED",
"correlationId": "string"
}
],
"schemaVersion": "1.0",
"pdid": "string",
"userId": "string",
"alertType": "string",
"payload": {"EventID": "string",
"Data": {"alertDataProperties": {"property1": { },
"property2": { }
},
"userProfile": {"lastUpdatedTime": "2019-08-24T14:15:22Z",
"userId": "string",
"firstName": "string",
"lastName": "string",
"locale": {"language": "string",
"country": "string",
"displayName": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": ["string"
],
"unicodeLocaleKeys": ["string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": ["string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"defaultEmail": "string",
"defaultPhoneNumber": "string",
"consent": true,
"nickNames": [{"nickName": "string",
"vehicleId": "string"
}
],
"timeZone": "string",
"lastModifiedTime": 0,
"customAttributes": {"property1": { },
"property2": { }
},
"schemaVersion": "1.0"
},
"vehicleProfile": {"vehicleId": "string",
"vehicleAttributes": {"property1": { },
"property2": { }
},
"vehicleAttributeLog": "string"
},
"notificationId": "string",
"marketingName": "string",
"mqttTopic": "string"
},
"Version": "string",
"BenchMode": 0,
"Timezone": 0,
"Timestamp": 0,
"pdid": "string"
},
"alertMessage": "string",
"read": true,
"deleted": true,
"campaignId": "string"
}
],
"pagination": {"total": {"pages": 0,
"records": 0
},
"size": 0,
"page": 0
}
}

API to get historical information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getAlertsBetweenSinceAndUntilV3

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
until required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

header Parameters

user-id

required

string

Responses

Response samples

200

Content type

application/json

{"property1": { },
"property2": { }
}

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getAlertsBetweenSinceAndUntilAndAlertTypeV3

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
until required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

header Parameters

user-id

required

string

Responses

Response samples

200

Content type

application/json

{"property1": { },
"property2": { }
}

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getAllAlertsBetweenSinceAndUntilV2

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
till required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

Responses

Response samples

200

Content type

application/json

{"property1": { },
"property2": { }
}

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getSpecificAlertBetweenSinceAndUntilV2

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
till required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

Responses

Response samples

200

Content type

application/json

{"property1": { },
"property2": { }
}

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getAlertsBetweenSinceAndUntilV2

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
till required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

header Parameters

user-id

required

string

Responses

Response samples

200

Content type

application/json

{"property1": { },
"property2": { }
}

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs

API to get information about Diagnostic Trouble Codes set by Vehicle ECUs
alerts-controller-getAlertsBetweenSinceAndUntilAndAlertTypeV2

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

since required	string [ 0 .. 9223372036854776000 ]
till required	string [ 0 .. 9223372036854776000 ]
size	string
page	string
readstatus	string Default: "all"

header Parameters

user-id

required

string

Responses

Response samples

200

Content type

application/json

{"property1": { },
"property2": { }
}

Delete alerts for a device

Delete alerts for a device
alerts-controller-deleteAlertsV1

SCOPE: [SelfManage,AssociateMyselfToVehicle]

Authorizations:

None

query Parameters

deleteType

string

Request Body schema: application/json

alertId

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"alertId": ["string"
]
}

notification-controller

Notification Center Api is used to send notification

Notification Center Api is used to send notification
notification-controller-createDynamicNotificationUserId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

userId	string
vehicleId	string
requestId	string
sessionId	string
clientRequestId	string
campaignId	string
userNotification	boolean
campaignNotification	boolean
dynamicNotification	boolean
Schedule	string
NotificationId required	string
Version	string
Timestamp required	integer <int64>
Timezone	integer <int32>
Brand	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"vehicleId": "string",
"requestId": "string",
"sessionId": "string",
"clientRequestId": "string",
"campaignId": "string",
"userNotification": true,
"campaignNotification": true,
"dynamicNotification": true,
"Schedule": "string",
"NotificationId": "string",
"Version": "string",
"Timestamp": 0,
"Timezone": 0,
"Brand": "string",
"Data": {"property1": { },
"property2": { }
}
}

Notification Center Api is used to create notification

Notification Center Api is used to create notification
notification-controller-createNotificationVehicleId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

vehicleId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

userId	string
vehicleId	string
requestId	string
sessionId	string
clientRequestId	string
campaignId	string
userNotification	boolean
campaignNotification	boolean
dynamicNotification	boolean
Schedule	string
NotificationId required	string
Version	string
Timestamp required	integer <int64>
Timezone	integer <int32>
Brand	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"vehicleId": "string",
"requestId": "string",
"sessionId": "string",
"clientRequestId": "string",
"campaignId": "string",
"userNotification": true,
"campaignNotification": true,
"dynamicNotification": true,
"Schedule": "string",
"NotificationId": "string",
"Version": "string",
"Timestamp": 0,
"Timezone": 0,
"Brand": "string",
"Data": {"property1": { },
"property2": { }
}
}

Notification Center Api is used to send notification

Notification Center Api is used to send notification
notification-controller-createCampaignNotifications

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

vehicleId required	string
campaignId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

userId	string
vehicleId	string
requestId	string
sessionId	string
clientRequestId	string
campaignId	string
userNotification	boolean
campaignNotification	boolean
dynamicNotification	boolean
Schedule	string
NotificationId required	string
Version	string
Timestamp required	integer <int64>
Timezone	integer <int32>
Brand	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"vehicleId": "string",
"requestId": "string",
"sessionId": "string",
"clientRequestId": "string",
"campaignId": "string",
"userNotification": true,
"campaignNotification": true,
"dynamicNotification": true,
"Schedule": "string",
"NotificationId": "string",
"Version": "string",
"Timestamp": 0,
"Timezone": 0,
"Brand": "string",
"Data": {"property1": { },
"property2": { }
}
}

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to create notification

Notification Center Api is used to create notification
notification-controller-createNotificationUserIdVehicleId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

userId	string
vehicleId	string
requestId	string
sessionId	string
clientRequestId	string
campaignId	string
userNotification	boolean
campaignNotification	boolean
dynamicNotification	boolean
Schedule	string
NotificationId required	string
Version	string
Timestamp required	integer <int64>
Timezone	integer <int32>
Brand	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"vehicleId": "string",
"requestId": "string",
"sessionId": "string",
"clientRequestId": "string",
"campaignId": "string",
"userNotification": true,
"campaignNotification": true,
"dynamicNotification": true,
"Schedule": "string",
"NotificationId": "string",
"Version": "string",
"Timestamp": 0,
"Timezone": 0,
"Brand": "string",
"Data": {"property1": { },
"property2": { }
}
}

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to create notification

Notification Center Api is used to create notification
notification-controller-createNotificationUserId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

userId	string
vehicleId	string
requestId	string
sessionId	string
clientRequestId	string
campaignId	string
userNotification	boolean
campaignNotification	boolean
dynamicNotification	boolean
Schedule	string
NotificationId required	string
Version	string
Timestamp required	integer <int64>
Timezone	integer <int32>
Brand	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"vehicleId": "string",
"requestId": "string",
"sessionId": "string",
"clientRequestId": "string",
"campaignId": "string",
"userNotification": true,
"campaignNotification": true,
"dynamicNotification": true,
"Schedule": "string",
"NotificationId": "string",
"Version": "string",
"Timestamp": 0,
"Timezone": 0,
"Brand": "string",
"Data": {"property1": { },
"property2": { }
}
}

Notification Center Api is used to send notification for non registered users

Notification Center Api is used to send notification for non registered users
notification-controller-createNotificationForNonRegisteredUsers

SCOPE: [ManageNonRegisteredUsersNotification]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

userId	string
vehicleId	string
requestId	string
sessionId	string
clientRequestId	string
schedule	string
campaignId	string
notificationId required	string
version	string
required	Array of objects (NonRegisteredUserData)

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"vehicleId": "string",
"requestId": "string",
"sessionId": "string",
"clientRequestId": "string",
"schedule": "string",
"campaignId": "string",
"notificationId": "string",
"version": "string",
"recipients": [{"brand": "string",
"locale": "string",
"email": "string",
"sms": "string",
"portal": "string",
"push": {"property1": "string",
"property2": "string"
},
"data": {"property1": { },
"property2": { }
}
}
]
}

Response samples

200

Content type

application/json

{"httpStatusCode": 0,
"requestId": "string",
"code": "string",
"reason": "string",
"msg": "string",
"errors": [{"code": "string",
"reason": "string",
"msg": "string"
}
],
"messageList": [{"code": "string",
"reason": "string",
"msg": "string"
}
]
}

Notification Center Api is used to create campaign id

Notification Center Api is used to create campaign id
notification-controller-createCampaign

SCOPE: [ManageNotifications]

Authorizations:

None

Responses

Response samples

200

Content type

application/json

{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"schemaVersion": "1.0"
}

Get nicknames for user and vin

Get nicknames for user and vin
notification-controller-getNickName

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string

header Parameters

RequestId	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to update nicknames

Notification Center Api is used to update nicknames
notification-controller-updateNickName

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string

header Parameters

RequestId	string
SessionId	string
ClientRequestId	string
If-Match required	string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Update user consent

Update user consent
notification-controller-updateConsent

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId

required

string

header Parameters

RequestId	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

notification-template-controller

Notification Center Api is used to import notification templates

Notification Center Api is used to import notification templates
notification-template-controller-updateNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Get a list of maps, each map contains notification id, notification short and long name.

Get a list of maps, each map contains notification id, notification short and long name.
notification-template-controller-filterNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Notification Center Api is used to import notification templates

Notification Center Api is used to import notification templates
notification-template-controller-importNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Delete all notification templates associate with all specified notification IDs

Delete all notification templates associate with all specified notification IDs
notification-template-controller-deleteNotificationTemplates

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

notificationTemplateIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"notificationTemplateIds": ["string"
]
}

Notification Center Api is used to export notification templates

Notification Center Api is used to export notification templates
notification-template-controller-filterNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

notificationTemplateIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"notificationTemplateIds": ["string"
]
}

Delete templates by notification ID,brand,locale and an additional lookup property

Delete templates by notification ID,brand,locale and an additional lookup property
notification-template-controller-deleteNotificationTemplateByIdBrandLocale

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

notificationId required	string
brand required	string
locale required	string

query Parameters

additionalLookupPropertyName	string
additionalLookupPropertyValue	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Notification Center Api is used to delete notification templates by notification id

Notification Center Api is used to delete notification templates by notification id
notification-template-controller-deleteNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

notificationId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

rich-content-notification-template-controller

Notification Center Api is used to import rich content notification templates

Notification Center Api is used to import rich content notification templates
rich-content-notification-template-controller-importNotificationTemplateByIdLocaleBrand

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Get a list of maps, each map contains notification id and last update time

Get a list of maps, each map contains notification id and last update time
rich-content-notification-template-controller-2

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Notification Center Api is used to import rich content notification templates

Notification Center Api is used to import rich content notification templates
rich-content-notification-template-controller-importNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Notification Center Api is used to export rich content notification templates

Notification Center Api is used to export rich content notification templates
rich-content-notification-template-controller-filterNotificationTemplate

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

notificationTemplateIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"notificationTemplateIds": ["string"
]
}

Delete rich templates by notification ID,brand,locale and an additional lookup property

Delete all notification rich template with the filter criteria
rich-content-notification-template-controller-deleteRichNotificationTemplateByIdBrandLocale

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

notificationId required	string
brand required	string
locale required	string

query Parameters

additionalLookupPropertyName	string
additionalLookupPropertyValue	string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

notification-history-controller

Notification Center Api is used to get notification status by vin

Notification Center Api is used to get notification status by vin
notification-history-controller-getNotificationHistoryVehicleId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

vehicleId

required

string

query Parameters

since required	integer <int64>
until required	integer <int64>
size required	integer <int32>
page required	integer <int32>
isNonRegisteredVehicle	boolean Default: false

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to get notification status by vin and user id

Notification Center Api is used to get notification status by vin and user id
notification-history-controller-getNotificationHistoryUserIdVehicleId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string

query Parameters

since required	integer <int64>
until required	integer <int64>
size required	integer <int32>
page required	integer <int32>
isNonRegisteredVehicle	boolean Default: false

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to get notification status by user id

Notification Center Api is used to get notification status by user id
notification-history-controller-getNotificationHistoryUserId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId

required

string

query Parameters

since required	integer <int64>
until required	integer <int64>
size required	integer <int32>
page required	integer <int32>

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to get notification by passing vin and platform id

Notification Center Api is used to get notification by passing vin and platform id
notification-history-controller-getNotificationStatusByVehicleIdAndPlatformId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

vehicleId required	string
platformResponseId required	string

query Parameters

content required	string
isNonRegisteredVehicle	boolean Default: false

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to get notification

Notification Center Api is used to get notification
notification-history-controller-getNotificationStatus

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
vehicleId required	string
platformResponseId required	string

query Parameters

content required	string
isNonRegisteredVehicle	boolean Default: false

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to get notification status

Notification Center Api is used to get notification status
notification-history-controller-getNotificationStatusByUserIdAndPlatformId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

userId required	string
platformResponseId required	string

query Parameters

content

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

Notification center API is used to get notification history of a campaign

Notification center API is used to get notification history of a campaign
notification-history-controller-getNotificationHistoryForCampaignId

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

campaignId

required

string

query Parameters

status required	string
size required	integer <int32>
page required	integer <int32>

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

Response samples

200

Content type

application/json

"string"

ivm-controller

Notification Center Api is used to recieve IVM response

Notification Center Api is used to recieve IVM response
ivm-controller-postIvmResponse

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

vehicleId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

vehicleId	string
messageId required	string
requestId required	string
sessionId required	string
sourceDeviceId	string
correlationId	string
timestamp required	integer <int64>
required	object (VehicleMessageDispositionPublishData)

Responses

Request samples

Payload

Content type

application/json

{"vehicleId": "string",
"messageId": "string",
"requestId": "string",
"sessionId": "string",
"sourceDeviceId": "string",
"correlationId": "string",
"timestamp": 0,
"vehicleMessageDispositionPublish": {"vehicleMessageID": 0,
"messageDisplayTimestamp": 0,
"messageHMIDispositionEventTimestamp": 0,
"failureDiagnostic": "string",
"campaignDate": "string",
"campaignId": "string",
"countryCode": "string",
"notificationId": "string",
"fileName": "string",
"harmanId": "string",
"disposition": "MESSAGE_CONFIRMED_BY_OPERATOR",
"customExtension": { }
}
}

Response samples

200

Content type

application/json

"string"

Notification Center Api is used to recieve IVM ACK

Notification Center Api is used to recieve IVM ACK
ivm-controller-postIvmAck

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

vehicleId

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

vehicleId	string
messageId required	string
requestId required	string
sessionId required	string
sourceDeviceId	string
correlationId	string
timestamp required	integer <int64>
required	object (VehicleMessageAckData)

Responses

Request samples

Payload

Content type

application/json

{"vehicleId": "string",
"messageId": "string",
"requestId": "string",
"sessionId": "string",
"sourceDeviceId": "string",
"correlationId": "string",
"timestamp": 0,
"vehicleMessageAck": {"failureDiagnostic": "string",
"messageReceiptTimestamp": 0,
"vehicleMessageID": 0,
"campaignDate": "string",
"campaignId": "string",
"countryCode": "string",
"fileName": "string",
"harmanId": "string",
"notificationId": "string",
"status": "MESSAGE_STAGED_FOR_DISPLAY",
"customExtension": { }
}
}

Response samples

200

Content type

application/json

"string"

placeholder-controller

Notification Center Api is used to import notification placeholders

Notification Center Api is used to import notification placeholders
placeholder-controller-importPlaceholders

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Notification Center Api is used to export notification placeholders for the specified key

Notification Center Api is used to export notification placeholders for the specified key
placeholder-controller-exportPlaceholders

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

key

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

API to delete all notification placeholders associated with the specified key

API to delete all notification placeholders associated with the specified key
placeholder-controller-deletePlaceholder

SCOPE: [ManageNotifications]

Authorizations:

None

path Parameters

key

required

string

header Parameters

RequestId required	string
SessionId	string
ClientRequestId	string

Responses

marketing-controller

Notification Center Api is used to update marketing names

Notification Center Api is used to update marketing names
marketing-controller-updateMarketingNames

SCOPE: [ManageNotifications]

Authorizations:

None

header Parameters

RequestId	string
SessionId	string
ClientRequestId	string

Request Body schema: application/json
required

Array

lastUpdatedTime	string <date-time>
id	string
brandName required	string
model	string
marketingName required	string
schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"

Responses

Request samples

Payload

Content type

application/json

[{"lastUpdatedTime": "2019-08-24T14:15:22Z",
"id": "string",
"brandName": "string",
"model": "string",
"marketingName": "string",
"schemaVersion": "1.0"
}
]

ro-engine-controller

PUT /v2/users/{userId}/vehicles/{vehicleId}/ro/engine

create Remote Engine Request v2
ro-engine-controller-createRemoteEngineRequest-v2

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, ROEngineB2BOwner, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "STARTED" "STOPPED" "IGNITION_DISABLED" "IGNITION_ENABLED" "SLOW_MOVING"
duration	integer <int32>
	object (ScheduleRequest)

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "STARTED",
"duration": 0,
"schedule": {"name": "string",
"scheduleTs": 0,
"recurrenceType": "YEARLY"
}
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string",
"schedulerKey": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/engine

create Remote Engine Request
ro-engine-controller-createRemoteEngineRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, ROEngineB2BOwner, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "STARTED" "STOPPED" "IGNITION_DISABLED" "IGNITION_ENABLED" "SLOW_MOVING"
duration	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "STARTED",
"duration": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

ro-hood-trunk-liftgate-controller

PUT /v2/ro/trunk

create Remote Trunk Request V2
ro-hood-trunk-liftgate-controller-createRemoteTrunkRequestV2

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
userId required	string
vehicleId required	string
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "OPENED" "CLOSED" "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v2/ro/liftgate

create Remote Lift Gate Request V2
ro-hood-trunk-liftgate-controller-createRemoteLiftgateRequestV2

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
userId required	string userId
vehicleId required	string vehicleId
PartnerId	string PartnerId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "OPENED" "CLOSED" "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/trunk

create Remote Trunk Request
ro-hood-trunk-liftgate-controller-createRemoteTrunkRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "OPENED" "CLOSED" "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/liftgate

create Remote Lift Gate Request
ro-hood-trunk-liftgate-controller-createRemoteLiftgateRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "OPENED" "CLOSED" "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/hood

create Remote Hood Request
ro-hood-trunk-liftgate-controller-createRemoteHoodRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "OPENED" "CLOSED" "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

ro-climate-controller

PUT /v2/ro/hvac

create Remote HVAC Request
ro-climate-controller-createRemoteHVACRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement]

Authorizations:

None

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
userId required	string
vehicleId required	string
PartnerId	string PartnerId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "ON" "OFF" "COMFORT_AUTO_ON_MODE_DISABLED" "COMFORT_AUTO_ON_MODE_START_ALL"
temperature	integer <int32>
temperatureUnit	string Enum: "CELSIUS" "FAHRENHEIT"
fanSpeed	integer <int32> [ 0 .. 100 ]
targetTemperature	number <double>
timeoutForAfterTemperature	integer <int32>
timeOutPreTrip	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "ON",
"temperature": 0,
"temperatureUnit": "CELSIUS",
"fanSpeed": 100,
"targetTemperature": 0.1,
"timeoutForAfterTemperature": 0,
"timeOutPreTrip": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/climate

create Remote Climate Request
ro-climate-controller-createRemoteClimateRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
PartnerId	string PartnerId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "ON" "OFF" "AUTO"
acState	string Enum: "ON" "OFF"
duration	integer <int32>
temperature	integer <int32>
fanSpeed	integer <int32>
temperatureUnit	string Enum: "CELSIUS" "FAHRENHEIT"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "ON",
"acState": "ON",
"duration": 0,
"temperature": 0,
"fanSpeed": 0,
"temperatureUnit": "CELSIUS"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

ro-glove-box-controller

PUT /v2/ro/glovebox

create Remote GloveBox Request
ro-glove-box-controller-createRemoteGloveBoxRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, EOLUser, ROGloveBoxB2BOwner, RODelegator]

Authorizations:

None

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
userId required	string
vehicleId required	string
PartnerId	string PartnerId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state required	string Enum: "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "LOCKED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

rcpd-controller

PUT /v1/rcpd

createRCPDRequest
rcpd-controller-createRCPDRequest

SCOPE: [RCPDSupportOwner, SelfManage, RCPDRequestB2BOwner]

Authorizations:

None

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
UserId required	string UserId
VehicleId required	string VehicleId

Responses

Response samples

202

Content type

application/json

{"message": "string",
"rcpdRequestId": "string"
}

GET /v1/rcpd/status

getRCPDStatus
rcpd-controller-getRCPDStatus

SCOPE: [RCPDSupportOwner, SelfManage]

Authorizations:

None

header Parameters

ClientRequestId	string ClientRequestId
SessionId required	string SessionId
RequestId required	string RequestId
OriginId required	string OriginId
UserId required	string UserId
VehicleId required	string VehicleId

Responses

Response samples

200

Content type

application/json

"string"

GET /v1/rcpd/requests/{rcpdRequestId}

get RCPDRequestStatus With RequestId
rcpd-controller-getRCPDRequestStatusWithRequestId

SCOPE: [RCPDSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement]

Authorizations:

None

path Parameters

rcpdRequestId

required

string

rcpdRequestId

query Parameters

responsesLimit

integer <int32>

Default: 10

responsesLimit

header Parameters

ClientRequestId	string ClientRequestId
SessionId required	string SessionId
RequestId required	string RequestId
OriginId required	string OriginId
UserId required	string UserId
VehicleId required	string VehicleId

Responses

Response samples

200

Content type

application/json

"string"

GET /v1/rcpd/history

fetchRCPDHistory
rcpd-controller-fetchRCPDHistory

SCOPE: [RCPDSupportOwner, SelfManage, RCPDHistoryOwner]

Authorizations:

None

query Parameters

eventId	string eventId
since	integer <int64> since
until	integer <int64> until
lastRecordId	string lastRecordId
sortOrder	string Default: "asc" sortOrder
responseCount	integer <int32> responseCount

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
UserId required	string UserId
VehicleId required	string VehicleId

Responses

Response samples

200

Content type

application/json

"string"

checkHealth api call

rcpd-controller-checkHealth

WARNING!! - Security Config Not Found

Responses

ro-horn-lights-alarm-controller

PUT /v1.2/users/{userId}/vehicles/{vehicleId}/ro/lights

create Remote Lights only
ro-horn-lights-alarm-controller-createRemoteLightsonly

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "ON" "OFF"
duration	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "ON",
"duration": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/lights

create Remote Lights Request
ro-horn-lights-alarm-controller-createRemoteLightsRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "ON" "OFF"
duration	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "ON",
"duration": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/horn

create Remote Horn Request
ro-horn-lights-alarm-controller-createRemoteHornRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "ON" "OFF"
duration	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "ON",
"duration": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/alarm

create Remote Alarm Request
ro-horn-lights-alarm-controller-createRemoteAlarmRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "ON" "OFF"
duration	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "ON",
"duration": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

ro-windows-controller

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/windows

create Remote Window Request
ro-windows-controller-createRemoteWindowRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "OPENED" "CLOSED" "PARTIAL_OPENED"
duration	integer <int32>
percent	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED",
"duration": 0,
"percent": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/windows/driver

create Remote Driver Window Request
ro-windows-controller-createRemoteDriverWindowRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string ecuType
vehicleArchType	string vehicleArchType
PartnerId	string PartnerId

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "OPENED" "CLOSED" "PARTIAL_OPENED"
duration	integer <int32>
percent	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "OPENED",
"duration": 0,
"percent": 0
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

ro-doors-controller

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/doors

create Remote Door Request
ro-doors-controller-createRemoteDoorRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, EOLUser, RODoorsB2BOwner, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
PartnerId	string PartnerId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "LOCKED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

PUT /v1.1/users/{userId}/vehicles/{vehicleId}/ro/doors/driver

create Remote Driver Door Request
ro-doors-controller-createRemoteDriverDoorRequest

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, EOLUser, RODoorsB2BOwner, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
PartnerId	string PartnerId
ecuType	string ecuType
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
state	string Enum: "LOCKED" "UNLOCKED"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"state": "LOCKED"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

remote-inhibit-controller

POST /v1.1/users/{userId}/vehicles/{vehicleId}/ro/inhibit

create RemoteInhibit Request
remote-inhibit-controller-createRemoteInhibitRequest

SCOPE: [StolenRemoteInhibitSupportOwner, FleetRemoteInhibitOwner, RemoteInhibitB2BOwner]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
ecuType	string
vehicleArchType	string vehicleArchType

Request Body schema: application/json
required

	object
mfaCode	integer <int32>
roRequestId	string
crankInhibit	string Enum: "END_INHIBIT" "INHIBIT"

Responses

Request samples

Payload

Content type

application/json

{"customExtension": {"property1": { },
"property2": { }
},
"mfaCode": 0,
"roRequestId": "string",
"crankInhibit": "END_INHIBIT"
}

Response samples

202

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

GET /v2/users/{userId}/vehicles/{vehicleId}/remoteinhibit/requests/{roRequestId}

get RI Response
remote-inhibit-controller-getRIResponse

SCOPE: [StolenRemoteInhibitSupportOwner, FleetRemoteInhibitOwner, RemoteInhibitB2BOwner]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId
roRequestId required	string roRequestId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId

Responses

Response samples

200

Content type

application/json

"string"

GET /v1.1/users/{userId}/vehicles/{vehicleId}/remoteinhibit/requests/{roRequestId}

get RI Response Partial
remote-inhibit-controller-getRIResponsePartial

SCOPE: [StolenRemoteInhibitSupportOwner, FleetRemoteInhibitOwner, RemoteInhibitB2BOwner]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId
roRequestId required	string roRequestId

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId

Responses

Response samples

200

Content type

application/json

"string"

ro-status-history-controller

GET /v2/ro/requests

get Remote Op Status V2
ro-status-history-controller-getRemoteOpStatusV2

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

query Parameters

responsesLimit

integer <int32>

Default: 10

responsesLimit

header Parameters

ClientRequestId	string
SessionId required	string SessionId
RequestId required	string RequestId
OriginId required	string OriginId
PartnerId	string PartnerId
userId required	string userId
vehicleId required	string vehicleId
roRequestId required	string roRequestId

Responses

Response samples

200

Content type

application/json

{"schemaVersion": "1.0",
"roEvent": {"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
},
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"roStatus": "PENDING",
"id": {"timestamp": 0,
"date": "2019-08-24T14:15:22Z"
},
"roResponseList": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
],
"deviceMessageFailures": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
],
"roNotificationList": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
]
}

GET /v2/ro/history

fetch Ro History For Portal
ro-status-history-controller-fetchRoHistoryForPortal

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, ROHistoryOwner, ROB2BOwner]

Authorizations:

None

query Parameters

eventId	string eventId
since	integer <int64> since
until	integer <int64> until
lastRecordId	string lastRecordId
sortOrder	string Default: "asc" sortOrder
responseCount	integer <int32> responseCount

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId
OriginId required	string OriginId
userId required	string userId
vehicleId required	string vehicleId
PartnerId	string PartnerId

Responses

Response samples

200

Content type

application/json

"string"

GET /v1.1/users/{userId}/vehicles/{vehicleId}/ro/requests/{roRequestId}

get Remote Op Status
ro-status-history-controller-getRemoteOpStatus

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId
roRequestId required	string roRequestId

query Parameters

responsesLimit

integer <int32>

Default: 10

responsesLimit

header Parameters

ClientRequestId	string
SessionId required	string SessionId
RequestId required	string RequestId
OriginId required	string OriginId
PartnerId	string PartnerId

Responses

Response samples

200

Content type

application/json

{"schemaVersion": "1.0",
"roEvent": {"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
},
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"roStatus": "PENDING",
"id": {"timestamp": 0,
"date": "2019-08-24T14:15:22Z"
},
"roResponseList": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
],
"deviceMessageFailures": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
],
"roNotificationList": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
]
}

GET /v1.1/users/{userId}/vehicles/{vehicleId}/ro/history

get Remote Op History
ro-status-history-controller-getRemoteOpHistory

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, RODelegator]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId

query Parameters

responsesLimit

integer <int32>

Default: 10

responsesLimit

header Parameters

ClientRequestId	string
SessionId required	string SessionId
RequestId required	string RequestId
OriginId required	string OriginId
PartnerId	string PartnerId

Responses

Response samples

200

Content type

application/json

{"schemaVersion": "1.0",
"roEvent": {"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
},
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"roStatus": "PENDING",
"id": {"timestamp": 0,
"date": "2019-08-24T14:15:22Z"
},
"roResponseList": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
],
"deviceMessageFailures": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
],
"roNotificationList": [{"responseExpected": true,
"platformId": "string",
"userContextInfo": [{"userId": "string",
"role": "string"
}
],
"shoulderTapEnabled": true,
"deviceDeliveryCutoff": 0,
"devMsgTopicSuffix": "string",
"duplicateMessage": true,
"ecuType": "string",
"mqttTopic": "string",
"timezone": 0,
"targetDeviceId": "string",
"deviceRoutable": true,
"transientData": true,
"kafkaHeaders": {"property1": "string",
"property2": "string"
},
"bizTransactionId": "string",
"messageId": "string",
"correlationId": "string",
"dffqualifier": "string",
"nestedEvents": [{ }
],
"eventData": { },
"vehicleId": "string",
"eventId": "string",
"sourceDeviceId": "string",
"requestId": "string",
"tracingContext": "string",
"timestamp": 0,
"version": "1.0",
"schemaVersion": "1.0"
}
]
}

ro-schedule-controller

GET /v1/users/{userId}/vehicles/{vehicleId}/ro/{roType}/schedules

get RO Schedules
ro-schedule-controller-getROSchedules

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, ROEngineB2BOwner]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId
roType required	string Enum: "REMOTE_OPERATION_CLIMATE" "REMOTE_OPERATION_ENGINE" "REMOTE_OPERATION_LIGHTS" "REMOTE_OPERATION_HORN" "REMOTE_OPERATION_ALARM" "REMOTE_OPERATION_DOORS" "REMOTE_OPERATION_DRIVERDOOR" "REMOTE_OPERATION_HOOD" "REMOTE_OPERATION_LIFTGATE" "REMOTE_OPERATION_TRUNK" "REMOTE_OPERATION_WINDOWS" "REMOTE_OPERATION_DRIVERWINDOW" roType

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId

Responses

Response samples

200

Content type

application/json

{"schedulerKey": "string",
"scheduleId": "string",
"scheduleTs": 0,
"name": "string",
"status": "ACTIVE",
"recurrenceType": "YEARLY",
"createdOn": 0,
"updatedOn": 0,
"zoneId": "string"
}

DELETE /v1/users/{userId}/vehicles/{vehicleId}/ro/{roType}/schedules

delete RO Schedules
ro-schedule-controller-deleteROSchedules

SCOPE: [ROSupportOwner, ROSupportThirdParty, SelfManage, ROSupportLawEnforcement, ROEngineB2BOwner]

Authorizations:

None

path Parameters

userId required	string userId
vehicleId required	string vehicleId
roType required	string Enum: "REMOTE_OPERATION_CLIMATE" "REMOTE_OPERATION_ENGINE" "REMOTE_OPERATION_LIGHTS" "REMOTE_OPERATION_HORN" "REMOTE_OPERATION_ALARM" "REMOTE_OPERATION_DOORS" "REMOTE_OPERATION_DRIVERDOOR" "REMOTE_OPERATION_HOOD" "REMOTE_OPERATION_LIFTGATE" "REMOTE_OPERATION_TRUNK" "REMOTE_OPERATION_WINDOWS" "REMOTE_OPERATION_DRIVERWINDOW" roType

header Parameters

ClientRequestId	string ClientRequestId
RequestId required	string RequestId
SessionId required	string SessionId

Request Body schema: application/json
required

schedulerKey

required

string

Responses

Request samples

Payload

Content type

application/json

{"schedulerKey": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"roRequestId": "string"
}

performance-monitor-controller

get api call

performance-monitor-controller-get

WARNING!! - Security Config Not Found

Responses

get api call

performance-monitor-controller-get

WARNING!! - Security Config Not Found

query Parameters

api

string

Responses

end user

Get my user cloud setting

Get my user cloud profile data

Allowed scopes: SelfManage
ETag behavior differs slightly from RFC specifications:

No support for list, only 1 ETag at a time
No support for '*' value. Either a specific value needs to be used or none at all
end user-getCloudProfileMap
SCOPE: [SelfManage]

Authorizations:

None

path Parameters

cloudProfileName

required

string

Profile name

header Parameters

If-None-Match	string
X-tenant-id	string Tenant ID
user-id required	string
correlationId	string Correlation ID

Responses

Response samples

200
400
404
500

Content type

application/json

[{"id": "string",
"userId": "string",
"cloudProfileName": "string",
"cloudProfileData": {"property1": { },
"property2": { }
}
}
]

Create or update a new cloud profile for user

This API creates a new profile for user or overwrites existing profile if already exists

Allowed scopes: SelfManage
ETag behavior differs slightly from RFC specifications:

No support for list, only 1 ETag at a time
No support for '*' value. Either a specific value needs to be used or none at all
end user-updateCloudProfile
SCOPE: [SelfManage]

Authorizations:

None

path Parameters

cloudProfileName

required

string

id

header Parameters

If-None-Match	string
X-tenant-id	string Tenant ID
user-id required	string
correlationId	string Correlation ID

Request Body schema: application/json
required

userId	integer User ID.
cloudProfileName	string [ 1 .. 49 ] characters Cloud profile name. Maximum length = 49 chars
	object cloud profile

Responses

Request samples

Payload

Content type

application/json

{"userId": 0,
"cloudProfileName": "userProfile",
"cloudProfileData": {"property1": { },
"property2": { }
}
}

Response samples

200
400
404
409
500

Content type

application/json

{"id": "string",
"userId": "string",
"cloudProfileName": "string",
"cloudProfileData": {"property1": { },
"property2": { }
}
}

Delete a cloud profile for user

Delete a specific profile for the user.

Allowed scopes: SelfManage
ETag behavior differs slightly from RFC specifications:

No support for list, only 1 ETag at a time
No support for '*' value. Either a specific value needs to be used or none at all
end user-deleteCloudProfile
SCOPE: [SelfManage]

Authorizations:

None

path Parameters

cloudProfileName

required

string

id

header Parameters

If-None-Match	string
X-tenant-id	string Tenant ID
user-id required	string
correlationId	string Correlation ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"userId": "string",
"cloudProfileName": "string",
"cloudProfileData": {"property1": { },
"property2": { }
}
}

Create or update a new cloud profile for user

This API creates a new profile for user or updates specific fields in existing profile if already exists.

Allowed scopes: SelfManage
ETag behavior differs slightly from RFC specifications:

No support for list, only 1 ETag at a time
No support for '*' value. Either a specific value needs to be used or none at all
end user-editCloudProfile
SCOPE: [SelfManage]

Authorizations:

None

path Parameters

cloudProfileName

required

string

id

header Parameters

If-None-Match	string
X-tenant-id	string Tenant ID
user-id required	string
correlationId	string Correlation ID

Request Body schema: application/json
required

object

cloud profile

Responses

Request samples

Payload

Content type

application/json

{"cloudProfileData": {"property1": { },
"property2": { }
}
}

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"userId": "string",
"cloudProfileName": "string",
"cloudProfileData": {"property1": { },
"property2": { }
}
}

Get my user cloud profile (setting) names and etags

Get my user cloud profile names and etags

Allowed scopes: SelfManage
ETag behavior differs slightly from RFC specifications:

No support for list, only 1 ETag at a time
No support for '*' value. Either a specific value needs to be used or none at all
end user-getCloudProfiles
SCOPE: [SelfManage]

Authorizations:

None

header Parameters

If-None-Match	string
X-tenant-id	string Tenant ID
user-id required	string
correlationId	string Correlation ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"property1": "string",
"property2": "string"
}

Reset password by the self user

Reset password by the self user
end user-sendUserResetPasswordNotification

SCOPE: [SelfManage]

Authorizations:

None

header Parameters

user-id

required

string

user-id

Responses

Response samples

200

Content type

application/json

"string"

Get my user data

Get my user data
end user-getSelfUser

SCOPE: [SelfManage]

Authorizations:

None

header Parameters

user-id

string

user-id

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Delete my own user

Delete my own user
end user-deleteSelfUser

SCOPE: [SelfManage]

Authorizations:

None

header Parameters

user-id	string user-id
external_user	boolean external_user

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Update logged in user.

Update logged in user.
end user-editSelfUser

SCOPE: [SelfManage]

Authorizations:

None

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

object (JsonPatch)

Parameters that update a single external user

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Get my user cloud profile (setting) etag

Get my user cloud profile etag in response body

Allowed scopes: SelfManage
ETag behavior differs slightly from RFC specifications:

No support for list, only 1 ETag at a time
No support for '*' value. Either a specific value needs to be used or none at all
end user-getCloudProfile
SCOPE: [SelfManage]

Authorizations:

None

path Parameters

cloudProfileName

required

string

Profile name

header Parameters

If-None-Match	string
X-tenant-id	string Tenant ID
user-id required	string
correlationId	string Correlation ID

Responses

Response samples

200
400
404
500

Content type

application/json

[{"id": "string",
"userId": "string",
"cloudProfileName": "string",
"cloudProfileData": {"property1": { },
"property2": { }
}
}
]

users

Get user attributes

Get user's entity attributes.
users-getUserAttributes

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"mandatory": true,
"unique": true,
"readOnly": true,
"searchable": true,
"dynamicAttribute": true,
"type": "string",
"regex": "string"
}
]

Add/Modify additional attributes to user

Add/Modify additional attributes to user entity.
users-putUserAttributes

SCOPE: [ManageUsers]

Authorizations:

None

Request Body schema: application/json
required

Array

name required	string [ 1 .. 79 ] characters ^[^_][a-z,A-Z,0-9_]{1,79}$ name
mandatory	boolean mandatory
unique	boolean unique
readOnly	boolean readOnly
searchable	boolean searchable
type	string type
regex	string regex

Responses

Request samples

Payload

Content type

application/json

[{"name": "isMarried",
"mandatory": false,
"unique": false,
"readOnly": false,
"searchable": true,
"type": "varchar",
"regex": "[a-zA-Z]{1,13}"
}
]

Response samples

200

Content type

application/json

[{"name": "string",
"mandatory": true,
"unique": true,
"readOnly": true,
"searchable": true,
"dynamicAttribute": true,
"type": "string",
"regex": "string"
}
]

Add a new user

Creates a new user with mapping to account and roles.
users-addUser

SCOPE: [ManageUsers]

Authorizations:

None

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

firstName	string [ 1 .. 49 ] characters First name. Maximum length = 49 chars
lastName	string [ 0 .. 49 ] characters Last name. Maximum length = 49 chars
country	string [ 1 .. 50 ] characters Country. Maximum length = 50 chars
state	string [ 1 .. 50 ] characters State. Maximum length = 50 chars
city	string [ 1 .. 50 ] characters City. Maximum length = 50 chars
address1	string [ 1 .. 50 ] characters Address. Maximum length = 50 chars
address2	string [ 1 .. 100 ] characters Address. Maximum length = 100 chars
postalCode	string [ 1 .. 11 ] characters Postal Code. Maximum length = 11 chars
phoneNumber	string^\+[0-9]{3,14}[0-9]$ Phone number. Minimum length = 5, Maximum length = 16 chars
email required	string [ 3 .. 128 ] characters Email address. Minimum length = 3, Maximum length = 128 chars
gender	string Enum: "MALE" "FEMALE" Gender
birthDate	string <date> Birth Date in ISO 8601 format (yyyy-MM-dd)
locale	string [ 1 .. 35 ] characters Locale. Maximum length = 35 chars
notificationConsent	boolean did the user approve to receive notifications
timeZone	string IST
userName required	string [ 1 .. 254 ] characters [^\\!()*~<>'\",:;\s${}\|+?%]{1,254}$ Username. Maximum length = 254 chars
password required	string User password. Password length should be between 6 to 80 chars and must use at least three of the four available character types: lowercase letters, uppercase letters, numbers, and any character from the following list: ** \|#$%&'()+,-./:;<=>?@[]^_`{}~ *
aud	string Client_Id/ AUD,mandatory when user created with client credentials flow
required	Array of objects (UserAccountsAndRoles_UserDtoV2View) unique Associated Accounts

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Doe",
"country": "USA",
"state": "Illinois",
"city": "Chicago",
"address1": 5801,
"address2": "S Ellis Ave",
"postalCode": 560068,
"phoneNumber": "+17535011234",
"email": "john.doe@domain.com",
"gender": "MALE",
"birthDate": "1997-10-13",
"locale": "en_US",
"notificationConsent": true,
"timeZone": "IST",
"userName": "johnd",
"password": "Aa1234",
"aud": "k8-qa-dmportal",
"accounts": "array of set of account name and roles"
}

Response samples

201

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"accounts": [{"account": "devAccount",
"roles": ["VEHICLE_OWNER"
]
}
]
}

POST /v2/users/filter - Retrieve users that match defined criteria

'V2 filter - Retrieves users that match items in the defined list of parameters and values.' List of parameters can contain dynamic attributes only if they were defined as 'searchable'.
users-getUsers-v2

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

query Parameters

pageNumber	integer <int32> Default: 0 Page number to retrieve; the first page is 0
pageSize	integer <int32> Default: 20 Number of items to display per page
sortBy	string Enum: "IDS" "USER_NAMES" "ROLES" "ROLEIDS" "ACCOUNTIDS" "STATUS" "FIRST_NAMES" "LAST_NAMES" "COUNTRIES" "STATES" "CITIES" "ADDRESS1" "ADDRESS2" "POSTAL_CODES" "PHONE_NUMBERS" "EMAILS" "GENDER" "LOCALES" "DEV_IDS" "TIMEZONE" "BIRTHDATE" "USERSTATUS" Parameters to sort by
sortOrder	string Enum: "DESC" "ASC" Sort in ascending (ASC) or descending (DESC) order; default: descending
ignoreCase	string Enum: "true" "false" Ignore case, true or false
searchType	string Enum: "PREFIX" "SUFFIX" "CONTAINS" Search type, CONTAINS, PREFIX or SUFFIX

Request Body schema: application/json
required

ids	Array of integers [ 1 .. 50 ] items unique List of user IDs
userNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 254 ] characters ] List of user-names
roles	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters [A-Za-z_-]+ ] List of user roles
firstNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters ] List of first names
lastNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters ] List of last names
countries	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of countries
states	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of states
cities	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of cities
address1	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of address line 1 addresses
address2	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 100 ] characters ] List of address line 2 addresses
postalCodes	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 11 ] characters ] List of postal codes
phoneNumbers	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 16 ] characters [0-9+]+ ] List of phone numbers
emails	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 128 ] characters ] List of emails
locales	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 35 ] characters ] List of locales
gender	Array of strings [ 1 .. 50 ] items unique Items Enum: "MALE" "FEMALE" Gender
devIds	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 256 ] characters ] List of device IDs
status	Array of strings [ 1 .. 50 ] items unique Items Enum: "PENDING" "BLOCKED" "REJECTED" "ACTIVE" "DELETED" "DEACTIVATED"
	object
accountNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 254 ] characters ] List of Account Names

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
],
"userNames": ["string"
],
"roles": ["string"
],
"firstNames": ["string"
],
"lastNames": ["string"
],
"countries": ["string"
],
"states": ["string"
],
"cities": ["string"
],
"address1": ["string"
],
"address2": ["string"
],
"postalCodes": ["string"
],
"phoneNumbers": ["string"
],
"emails": ["string"
],
"locales": ["string"
],
"gender": "MALE",
"devIds": ["string"
],
"status": ["PENDING"
],
"additionalAttributes": {"property1": ["string"
],
"property2": ["string"
]
},
"accountNames": ["string"
]
}

Response samples

201

Content type

application/json

[{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"accounts": [{"account": "devAccount",
"roles": ["VEHICLE_OWNER"
]
}
]
}
]

Add a new user

Creates a new user.
users-addUser

SCOPE: [ManageUsers]

Authorizations:

None

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

firstName	string [ 1 .. 49 ] characters First name. Maximum length = 49 chars
lastName	string [ 0 .. 49 ] characters Last name. Maximum length = 49 chars
country	string [ 1 .. 50 ] characters Country. Maximum length = 50 chars
state	string [ 1 .. 50 ] characters State. Maximum length = 50 chars
city	string [ 1 .. 50 ] characters City. Maximum length = 50 chars
address1	string [ 1 .. 50 ] characters Address. Maximum length = 50 chars
address2	string [ 1 .. 100 ] characters Address. Maximum length = 100 chars
postalCode	string [ 1 .. 11 ] characters Postal Code. Maximum length = 11 chars
phoneNumber	string^\+[0-9]{3,14}[0-9]$ Phone number. Minimum length = 5, Maximum length = 16 chars
email required	string [ 3 .. 128 ] characters Email address. Minimum length = 3, Maximum length = 128 chars
gender	string Enum: "MALE" "FEMALE" Gender
birthDate	string <date> Birth Date in ISO 8601 format (yyyy-MM-dd)
locale	string [ 1 .. 35 ] characters Locale. Maximum length = 35 chars
notificationConsent	boolean did the user approve to receive notifications
timeZone	string IST
userName required	string [ 1 .. 254 ] characters [^\\!()*~<>'\",:;\s${}\|+?%]{1,254}$ Username. Maximum length = 254 chars
password required	string User password. Password length should be between 6 to 80 chars and must use at least three of the four available character types: lowercase letters, uppercase letters, numbers, and any character from the following list: ** \|#$%&'()+,-./:;<=>?@[]^_`{}~ *
aud	string Client_Id/ AUD,mandatory when user created with client credentials flow
roles required	Array of strings unique Role. Allowed values are: [VEHICLE_OWNER, OEM_ADMIN, BUSINESS_ADMIN] or one of the defined custom roles

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Doe",
"country": "USA",
"state": "Illinois",
"city": "Chicago",
"address1": 5801,
"address2": "S Ellis Ave",
"postalCode": 560068,
"phoneNumber": "+17535011234",
"email": "john.doe@domain.com",
"gender": "MALE",
"birthDate": "1997-10-13",
"locale": "en_US",
"notificationConsent": true,
"timeZone": "IST",
"userName": "johnd",
"password": "Aa1234",
"aud": "k8-qa-dmportal",
"roles": ["VEHICLE_OWNER"
]
}

Response samples

201

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Delete users that match defined criteria

Delete users that match defined criteria
users-deleteUsersByFilter

SCOPE: [ManageUsers]

Authorizations:

None

Request Body schema: application/json
required

ids	Array of integers [ 1 .. 50 ] items unique List of user IDs

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Retrieve users that match defined criteria

'Retrieves users that match items in the defined list of parameters and values.' List of parameters can contain dynamic attributes only if they were defined as 'searchable'.
users-getUsers-v1

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

query Parameters

pageNumber	integer <int32> Default: 0 Page number to retrieve; the first page is 0
pageSize	integer <int32> Default: 20 Number of items to display per page
sortBy	string Enum: "IDS" "USER_NAMES" "ROLES" "ROLEIDS" "ACCOUNTIDS" "STATUS" "FIRST_NAMES" "LAST_NAMES" "COUNTRIES" "STATES" "CITIES" "ADDRESS1" "ADDRESS2" "POSTAL_CODES" "PHONE_NUMBERS" "EMAILS" "GENDER" "LOCALES" "DEV_IDS" "TIMEZONE" "BIRTHDATE" "USERSTATUS" Parameters to sort by
sortOrder	string Enum: "DESC" "ASC" Sort in ascending (ASC) or descending (DESC) order; default: descending
ignoreCase	string Enum: "true" "false" Ignore case, true or false
searchType	string Enum: "PREFIX" "SUFFIX" "CONTAINS" Search type, CONTAINS, PREFIX or SUFFIX

Request Body schema: application/json
required

ids	Array of integers [ 1 .. 50 ] items unique List of user IDs
userNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 254 ] characters ] List of user-names
roles	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters [A-Za-z_-]+ ] List of user roles
firstNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters ] List of first names
lastNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters ] List of last names
countries	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of countries
states	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of states
cities	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of cities
address1	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 50 ] characters ] List of address line 1 addresses
address2	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 100 ] characters ] List of address line 2 addresses
postalCodes	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 11 ] characters ] List of postal codes
phoneNumbers	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 16 ] characters [0-9+]+ ] List of phone numbers
emails	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 128 ] characters ] List of emails
locales	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 35 ] characters ] List of locales
gender	Array of strings [ 1 .. 50 ] items unique Items Enum: "MALE" "FEMALE" Gender
devIds	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 256 ] characters ] List of device IDs
status	Array of strings [ 1 .. 50 ] items unique Items Enum: "PENDING" "BLOCKED" "REJECTED" "ACTIVE" "DELETED" "DEACTIVATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
],
"userNames": ["string"
],
"roles": ["string"
],
"firstNames": ["string"
],
"lastNames": ["string"
],
"countries": ["string"
],
"states": ["string"
],
"cities": ["string"
],
"address1": ["string"
],
"address2": ["string"
],
"postalCodes": ["string"
],
"phoneNumbers": ["string"
],
"emails": ["string"
],
"locales": ["string"
],
"gender": "MALE",
"devIds": ["string"
],
"status": ["PENDING"
],
"additionalAttributes": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

[{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}
]

Add a federated user

Creates a federated user.
users-addFederatedUser

SCOPE: [ManageUsers]

Authorizations:

None

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

firstName	string [ 1 .. 49 ] characters First name. Maximum length = 49 chars
lastName	string [ 0 .. 49 ] characters Last name. Maximum length = 49 chars
country	string [ 1 .. 50 ] characters Country. Maximum length = 50 chars
state	string [ 1 .. 50 ] characters State. Maximum length = 50 chars
city	string [ 1 .. 50 ] characters City. Maximum length = 50 chars
address1	string [ 1 .. 50 ] characters Address. Maximum length = 50 chars
address2	string [ 1 .. 100 ] characters Address. Maximum length = 100 chars
postalCode	string [ 1 .. 11 ] characters Postal Code. Maximum length = 11 chars
phoneNumber	string^\+[0-9]{3,14}[0-9]$ Phone number. Minimum length = 5, Maximum length = 16 chars
email required	string [ 3 .. 128 ] characters Email address. Minimum length = 3, Maximum length = 128 chars
gender	string Enum: "MALE" "FEMALE" Gender
birthDate	string <date> Birth Date in ISO 8601 format (yyyy-MM-dd)
locale	string [ 1 .. 35 ] characters Locale. Maximum length = 35 chars
notificationConsent	boolean did the user approve to receive notifications
timeZone	string IST
userName required	string [ 1 .. 254 ] characters [^\\!()*~<>'\",:;\s${}\|+?%]{1,254}$ Username. Maximum length = 254 chars
roles required	Array of strings unique Role. Allowed values are: [VEHICLE_OWNER, OEM_ADMIN, BUSINESS_ADMIN] or one of the defined custom roles
identity_provider_name required	string Identity Provider Name. The name of the provider that identified this user

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Doe",
"country": "USA",
"state": "Illinois",
"city": "Chicago",
"address1": 5801,
"address2": "S Ellis Ave",
"postalCode": 560068,
"phoneNumber": "+17535011234",
"email": "john.doe@domain.com",
"gender": "MALE",
"birthDate": "1997-10-13",
"locale": "en_US",
"notificationConsent": true,
"timeZone": "IST",
"userName": "johnd",
"roles": ["VEHICLE_OWNER"
],
"identity_provider_name": "Google"
}

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Add a new external user

Creates a new external user.
users-addExternalUser

SCOPE: [ManageUsers]

Authorizations:

None

header Parameters

user-id

required

string

user-id

Request Body schema: application/json
required

firstName	string [ 1 .. 49 ] characters First name. Maximum length = 49 chars
lastName	string [ 0 .. 49 ] characters Last name. Maximum length = 49 chars
country	string [ 1 .. 50 ] characters Country. Maximum length = 50 chars
state	string [ 1 .. 50 ] characters State. Maximum length = 50 chars
city	string [ 1 .. 50 ] characters City. Maximum length = 50 chars
address1	string [ 1 .. 50 ] characters Address. Maximum length = 50 chars
address2	string [ 1 .. 100 ] characters Address. Maximum length = 100 chars
postalCode	string [ 1 .. 11 ] characters Postal Code. Maximum length = 11 chars
phoneNumber	string^\+[0-9]{3,14}[0-9]$ Phone number. Minimum length = 5, Maximum length = 16 chars
email required	string [ 3 .. 128 ] characters Email address. Minimum length = 3, Maximum length = 128 chars
gender	string Enum: "MALE" "FEMALE" Gender
birthDate	string <date> Birth Date in ISO 8601 format (yyyy-MM-dd)
locale	string [ 1 .. 35 ] characters Locale. Maximum length = 35 chars
notificationConsent	boolean did the user approve to receive notifications
timeZone	string IST
userName required	string [ 1 .. 254 ] characters [^\\!()*~<>'\",:;\s${}\|+?%]{1,254}$ Username. Maximum length = 254 chars
roles required	Array of strings unique Role. Allowed values are: [VEHICLE_OWNER, OEM_ADMIN, BUSINESS_ADMIN] or one of the defined custom roles

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Doe",
"country": "USA",
"state": "Illinois",
"city": "Chicago",
"address1": 5801,
"address2": "S Ellis Ave",
"postalCode": 560068,
"phoneNumber": "+17535011234",
"email": "john.doe@domain.com",
"gender": "MALE",
"birthDate": "1997-10-13",
"locale": "en_US",
"notificationConsent": true,
"timeZone": "IST",
"userName": "johnd",
"roles": ["VEHICLE_OWNER"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Get a user

Gets a single user identified by its ID as per version 2
users-getUser

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"accounts": [{"account": "devAccount",
"roles": ["VEHICLE_OWNER"
]
}
]
}

Update a user

Updates a single user identified by its ID as per version 2
users-editUser

SCOPE: [ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

object (JsonPatch)

Parameters that update a single external user

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"accounts": [{"account": "devAccount",
"roles": ["VEHICLE_OWNER"
]
}
]
}

Associate Users to Accounts with Roles

Associate Users to Accounts with Roles
users-associateAccountAndRoles

SCOPE: [ManageUsers, ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

userId

required

integer

User ID

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

Array

op required	string^remove\|add\|ADD\|REMOVE$ Incorrect Op key. Allowed values are: [ADD\|REMOVE]
path required	string^/account/\d+(/[A-Za-z0-9_-]+){0,1}$
value	string

Responses

Request samples

Payload

Content type

application/json

[{"op": "ADD",
"path": "string",
"value": "string"
}
]

Response samples

201

Content type

application/json

{"accounts": [{"account": "devAccount",
"roles": ["VEHICLE_OWNER"
]
}
]
}

Get a user

Gets a single user identified by its ID
users-getUser

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Delete a user

Deletes a single user identified by its ID
users-deleteUser

SCOPE: [ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

header Parameters

user-id required	string user-id
external_user	boolean external_user

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Update a user

Updates a single user identified by its ID
users-editUser

SCOPE: [ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

object (JsonPatch)

Parameters that update a single external user

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Change user status

Change status for users.
users-changeUserStatus

SCOPE: [ManageUsers]

Authorizations:

None

header Parameters

user-id

required

string

user-id

Request Body schema: application/json
required

ids required	Array of integers [ 1 .. 50 ] items unique List of user IDs.
approved	boolean

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
],
"approved": true
}

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Get external user

Gets a single external user identified by its ID.
users-getExternalUser

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Delete an external user

Deletes a single external user identified by its ID
users-deleteExternalUser

SCOPE: [ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

header Parameters

user-id

required

string

user-id

Responses

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

Update an external user

Updates a single external user identified by its ID
users-editExternalUser

SCOPE: [ManageUsers]

Authorizations:

None

path Parameters

id

required

integer

User ID

header Parameters

user-id

string

user-id

Request Body schema: application/json
required

object (JsonPatch)

Parameters that update a single external user

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"id": 0,
"userName": "string",
"status": "PENDING",
"firstName": "string",
"lastName": "string",
"country": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"postalCode": "string",
"phoneNumber": "string",
"email": "string",
"gender": "MALE, FEMALE",
"birthDate": "1997-10-13",
"locale": "string",
"notificationConsent": true,
"timeZone": "IST",
"devIds": ["string"
],
"roles": ["string"
]
}

client-registration-controller

Get ClientDetails

Get registered client details
client-registration-controller-getClient

SCOPE: [OAuth2ClientMgmt]

Authorizations:

None

path Parameters

clientId

required

string

query Parameters

status

string

Responses

Response samples

200

Content type

application/json

[{"code": "string",
"message": "string",
"data": { },
"httpStatus": "100 CONTINUE"
}
]

update client

update existing client
client-registration-controller-updateClient

SCOPE: [OAuth2ClientMgmt]

Authorizations:

None

path Parameters

clientId

required

string

Request Body schema: application/json
required

clientId	string
clientSecret	string
clientName	string
clientAuthenticationMethods	Array of strings
authorizationGrantTypes	Array of strings
redirectUris	Array of strings
scopes	Array of strings unique
accessTokenValidity	integer <int32>
refreshTokenValidity	integer <int32>
authorizationCodeValidity	integer <int32>
additionalInformation	string
requireAuthorizationConsent	boolean
status	string
requestedBy	string

Responses

Request samples

Payload

Content type

application/json

{"clientId": "string",
"clientSecret": "string",
"clientName": "string",
"clientAuthenticationMethods": ["string"
],
"authorizationGrantTypes": ["string"
],
"redirectUris": ["string"
],
"scopes": ["string"
],
"accessTokenValidity": 0,
"refreshTokenValidity": 0,
"authorizationCodeValidity": 0,
"additionalInformation": "string",
"requireAuthorizationConsent": true,
"status": "string",
"requestedBy": "string"
}

Response samples

200

Content type

application/json

[{"code": "string",
"message": "string",
"data": { },
"httpStatus": "100 CONTINUE"
}
]

delete client

delete existing client
client-registration-controller-deleteClient

SCOPE: [OAuth2ClientMgmt]

Authorizations:

None

path Parameters

clientId

required

string

Responses

Response samples

200

Content type

application/json

[{"code": "string",
"message": "string",
"data": { },
"httpStatus": "100 CONTINUE"
}
]

Create client

register a new client
client-registration-controller-createClient

SCOPE: [OAuth2ClientMgmt]

Authorizations:

None

Request Body schema: application/json
required

clientId	string
clientSecret	string
clientName	string
clientAuthenticationMethods	Array of strings
authorizationGrantTypes	Array of strings
redirectUris	Array of strings
scopes	Array of strings unique
accessTokenValidity	integer <int32>
refreshTokenValidity	integer <int32>
authorizationCodeValidity	integer <int32>
additionalInformation	string
requireAuthorizationConsent	boolean
status	string
requestedBy	string

Responses

Request samples

Payload

Content type

application/json

{"clientId": "string",
"clientSecret": "string",
"clientName": "string",
"clientAuthenticationMethods": ["string"
],
"authorizationGrantTypes": ["string"
],
"redirectUris": ["string"
],
"scopes": ["string"
],
"accessTokenValidity": 0,
"refreshTokenValidity": 0,
"authorizationCodeValidity": 0,
"additionalInformation": "string",
"requireAuthorizationConsent": true,
"status": "string",
"requestedBy": "string"
}

Response samples

201

Content type

application/json

[{"code": "string",
"message": "string",
"data": { },
"httpStatus": "100 CONTINUE"
}
]

cloud-profile-controller

addCloudProfile api call

cloud-profile-controller-addCloudProfile

WARNING!! - Security Config Not Found

Request Body schema: application/json
required

userId	integer User ID.
cloudProfileName	string [ 1 .. 49 ] characters Cloud profile name. Maximum length = 49 chars
	object cloud profile

Responses

Request samples

Payload

Content type

application/json

{"userId": 0,
"cloudProfileName": "userProfile",
"cloudProfileData": {"property1": { },
"property2": { }
}
}

Response samples

200

Content type

application/json

{"id": "string",
"userId": "string",
"cloudProfileName": "string",
"cloudProfileData": {"property1": { },
"property2": { }
}
}

scopes-controller

Create New Scope

Create a new scope
scopes-controller-createScope

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

header Parameters

user-id required	string
scope required	string

Request Body schema: application/json
required

name required	string
description required	string
administrative required	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"administrative": true
}

Response samples

201

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]

Filter Scope

Filter scope details
scopes-controller-filterScopes

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

query Parameters

page	integer <int32> Default: 0
pageSize	integer <int32> Default: 20

Request Body schema: application/json
required

scopes

required

Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"scopes": ["string"
]
}

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]

Get Scope

Get scope details
scopes-controller-getScope

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]

Delete Scope

Delete scope
scopes-controller-deleteScope

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

name

required

string

header Parameters

user-id required	string
scope required	string

Responses

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]

Update Scope

Update scope details
scopes-controller-updateScope

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

name

required

string

header Parameters

user-id required	string
scope required	string

Request Body schema: application/json
required

description	string
administrative	boolean

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"administrative": true
}

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]

roles-controller

Create Role

Create a new role
roles-controller-createRole

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

header Parameters

user-id required	string
scope required	string

Request Body schema: application/json
required

name required	string
description required	string
scopeNames required	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"scopeNames": ["string"
]
}

Response samples

201

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"id": 0,
"name": "string",
"description": "string",
"scopes": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]
}
]

Get Role By Id

Get role information by role id
roles-controller-getRoleById

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

Request Body schema: application/json
required

roleId

required

Array of integers unique

Responses

Request samples

Payload

Content type

application/json

{"roleId": [0
]
}

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"id": 0,
"name": "string",
"description": "string",
"scopes": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]
}
]

Filter Role

Get multiple roles information by role names
roles-controller-filterRoles

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

query Parameters

page	integer <int32> Default: 0
pageSize	integer <int32> Default: 20

Request Body schema: application/json
required

roles

required

Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"roles": ["string"
]
}

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"id": 0,
"name": "string",
"description": "string",
"scopes": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]
}
]

Get Role By Name

Get role information by role name
roles-controller-getRole

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"id": 0,
"name": "string",
"description": "string",
"scopes": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]
}
]

Delete Role

Deletes a single role using its unique name.
roles-controller-deleteRole

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

name

required

string

header Parameters

user-id required	string
scope required	string

Responses

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"id": 0,
"name": "string",
"description": "string",
"scopes": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]
}
]

Update Role

Update existing role details
roles-controller-updateRole

SCOPE: [ManageUserRolesAndPermissions]

Authorizations:

None

path Parameters

name

required

string

header Parameters

user-id required	string
scope required	string

Request Body schema: application/json
required

description	string
scopeNames required	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"scopeNames": ["string"
]
}

Response samples

200

Content type

application/json

[{"messages": [{"key": "success.key",
"parameters": [{ }
]
}
],
"results": [{"id": 0,
"name": "string",
"description": "string",
"scopes": [{"name": "string",
"description": "string",
"administrative": true,
"predefined": true
}
]
}
]
}
]

account

Create a new account

Creates a new Account.
account-createAccount

SCOPE: [ManageAccounts]

Authorizations:

None

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Request Body schema: application/json
required

parentId	string Parent ID of the account
roles	Array of strings unique Role. Allowed values are: [VEHICLE_OWNER, OEM_ADMIN, BUSINESS_ADMIN] or one of the defined custom roles
accountName required	string [ 1 .. 254 ] characters Account name. Maximum length is 254 chars

Responses

Request samples

Payload

Content type

application/json

{"parentId": 1,
"roles": ["TENANT_ADMIN"
],
"accountName": "sampleAccount"
}

Response samples

201

Content type

application/json

{"id": "string"
}

Get account details

Gets the account identified by its ID
account-getAccount

SCOPE: [ViewAccounts, ManageAccounts]

Authorizations:

None

path Parameters

account_id

required

integer

Account ID

header Parameters

correlationId	string Correlation ID
user-id	string user-id

Responses

Response samples

200

Content type

application/json

{"id": "string",
"accountName": "string",
"parentId": "string",
"roles": ["string"
],
"status": "PENDING",
"createdBy": "string",
"createDate": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateDate": "2019-08-24T14:15:22Z"
}

Update an existing account

Update an existing account
account-updateAccount

SCOPE: [ManageAccounts]

Authorizations:

None

path Parameters

account_id

required

integer

Account id

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Request Body schema: application/json
required

parentId	string Parent ID of the account
roles	Array of strings unique Role. Allowed values are: [VEHICLE_OWNER, OEM_ADMIN, BUSINESS_ADMIN] or one of the defined custom roles
status required	string Enum: "PENDING" "ACTIVE" "SUSPENDED" "BLOCKED" "DELETED" Status. Allowed values are: [PENDING, REJECTED, ACTIVE, DEACTIVATED]

Responses

Request samples

Payload

Content type

application/json

{"parentId": 1,
"roles": ["TENANT_ADMIN"
],
"status": "PENDING"
}

Response samples

200

Content type

application/json

"string"

Delete an existing account

Account must not be default and no users associated
account-deleteAccount

SCOPE: [ManageAccounts]

Authorizations:

None

path Parameters

account_id

required

integer

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Responses

Response samples

200

Content type

application/json

"string"

Retrieve accounts that match the defined criteria

Retrieves Accounts that match items in the defined list of parameters and values.
account-filterAccounts

SCOPE: [ViewAccounts, ManageAccounts]

Authorizations:

None

query Parameters

sortBy	string Default: "ACCOUNT_NAMES" Enum: "IDS" "ACCOUNT_NAMES" "PARENTIDS" "ROLES" "STATUS" Parameters to sort by
sortOrder	string Enum: "DESC" "ASC" Sort in ascending (ASC) or descending (DESC) order; default: descending
ignoreCase	string Enum: "true" "false" Ignore case, true or false
searchMode	string Enum: "PREFIX" "SUFFIX" "CONTAINS" "EQUAL" Search type, CONTAINS, PREFIX, SUFFIX or EQUAL

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Request Body schema: application/json
required

ids	Array of integers [ 1 .. 50 ] items unique List of Account IDs
accountNames	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 254 ] characters ] List of Account Names
parentIds	Array of integers [ 1 .. 50 ] items unique List of Parent Ids
roles	Array of strings [ 1 .. 50 ] items unique [ items [ 1 .. 49 ] characters [A-Za-z_-]+ ] List of Account roles
status	Array of strings [ 1 .. 50 ] items unique Items Enum: "PENDING" "ACTIVE" "SUSPENDED" "BLOCKED" "DELETED"

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
],
"accountNames": ["string"
],
"parentIds": [0
],
"roles": ["string"
],
"status": ["PENDING"
]
}

Response samples

200

Content type

application/json

[{"id": "string",
"accountName": "string",
"parentId": "string",
"roles": ["string"
],
"status": "PENDING",
"createdBy": "string",
"createDate": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateDate": "2019-08-24T14:15:22Z"
}
]

password-policy-controller

Get all password policies

Fetches all available password policies
password-policy-controller-getAllPasswordPolicies

SCOPE: [ManageAccounts]

Authorizations:

None

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Responses

Response samples

200

Content type

application/json

{"passwordPolicies": [{"name": "string",
"key": "string",
"description": "string",
"validationRules": {"property1": { },
"property2": { }
},
"priority": 0,
"required": true
}
]
}

Update password policies

Updates password policies following JSON Patch format
password-policy-controller-updatePasswordPolicies

SCOPE: [ManageAccounts]

Authorizations:

None

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Request Body schema: application/json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/json

{ }

Get password policy by key

Fetches a specific password policy by its key
password-policy-controller-getPolicyByKey

SCOPE: [ManageAccounts]

Authorizations:

None

path Parameters

policyKey

required

string

Policy key

header Parameters

user-id required	string user-id
correlationId	string Correlation ID

Responses

email

Get if user email was verified by user id

Get if user email was verified by user id.
email-getIsEmailVerified

SCOPE: [ViewUsers, ManageUsers]

Authorizations:

None

path Parameters

userId

required

string

userId

Responses

Verify email address via UUID

API requires only a valid link (i.e. UUID) to validate an email.
email-verifyEmail

WARNING!! - Security Config Not Found

path Parameters

token

required

string

Responses

vehicle-profile-controller-v-2

PUT /v2/vehicleProfiles/vin/replace

vehicle-profile-controller-v-2-replaceVin

SCOPE: [IgniteSystem]

Authorizations:

None

Request Body schema: application/json
required

deviceId	string
vin	string

Responses

Request samples

Payload

Content type

application/json

{"deviceId": "string",
"vin": "string"
}

vehicle-profile-controller

PUT /v1.0/vehicleProfiles/vin/replace

vehicle-profile-controller-replaceVin

SCOPE: [IgniteSystem]

Authorizations:

None

Request Body schema: application/json
required

deviceId	string
vin	string

Responses

Request samples

Payload

Content type

application/json

{"deviceId": "string",
"vin": "string"
}

GET /v1.0/vehicleProfiles/

vehicle-profile-controller-search

SCOPE: [SelfManage]

Authorizations:

None

query Parameters

required

object

Responses

POST /v1.0/vehicleProfiles

vehicle-profile-controller-post

SCOPE: [IgniteSystem]

Authorizations:

None

Request Body schema: application/json
required

schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"
vin	string
vehicleId	string
createdOn	string <date-time>
updatedOn	string <date-time>
productionDate	string <date-time>
soldRegion	string
saleDate	string
	object (VehicleAttributes)
	Array of objects (User)
	object (ModemInfo)
vehicleArchType	string
	object
dummy	boolean
	object
	object
	object (VehicleCapabilities)
	object (SaleAttributes)
eolValidationInProgress	boolean
blockEnrollment	boolean
	object
epiddbChecksum	string
connectedPlatform	string
lastUpdatedTime	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"schemaVersion": "1.0",
"vin": "string",
"vehicleId": "string",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"productionDate": "2019-08-24T14:15:22Z",
"soldRegion": "string",
"saleDate": "string",
"vehicleAttributes": {"make": "string",
"model": "string",
"marketingColor": "string",
"baseColor": "string",
"modelYear": "string",
"destinationCountry": "string",
"engineType": "string",
"bodyStyle": "string",
"bodyType": "string",
"name": "string",
"trim": "string",
"type": "string",
"fuelType": 0
},
"authorizedUsers": [{"userId": "string",
"role": "string",
"source": "string",
"status": "string",
"tc": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"pp": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"modemInfo": {"eid": "string",
"iccid": "string",
"imei": "string",
"msisdn": "string",
"imsi": "string"
},
"vehicleArchType": "string",
"ecus": {"property1": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
},
"property2": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
}
},
"dummy": true,
"events": {"property1": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
},
"property2": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
}
},
"customParams": {"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"vehicleCapabilities": {"sourceType": "string",
"pids": ["string"
],
"useCases": ["string"
]
},
"saleAttributes": {"dealerCode": "string",
"saleDate": "2019-08-24T14:15:22Z",
"eventType": "string",
"eventDate": "2019-08-24T14:15:22Z",
"warrantyStartDate": "2019-08-24T14:15:22Z",
"marketCode": "string",
"salesChannel": "string",
"customerSegment": "string"
},
"eolValidationInProgress": true,
"blockEnrollment": true,
"authorizedPartners": {"property1": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
},
"property2": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
}
},
"epiddbChecksum": "string",
"connectedPlatform": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z"
}

POST /v1.0/vehicleProfiles/{id}/inventory

vehicle-profile-controller-updateInventory

SCOPE: [IgniteSystem]

Authorizations:

None

path Parameters

id

required

string

Request Body schema: application/json
required

	object
inventoryversion	string
vin	string
timestamp	string <date-time>
campaignid	string

Responses

Request samples

Payload

Content type

application/json

{"inventoryEcuMap": {"property1": {"inventoryScomoMap": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
},
"partnumber": "string",
"hardware": {"version": "string",
"serialnumber": "string"
}
},
"property2": {"inventoryScomoMap": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
},
"partnumber": "string",
"hardware": {"version": "string",
"serialnumber": "string"
}
}
},
"inventoryversion": "string",
"vin": "string",
"timestamp": "2019-08-24T14:15:22Z",
"campaignid": "string"
}

PATCH /v1.0/vehicleProfiles/{vehicleId}

vehicle-profile-controller-update

SCOPE: [IgniteSystem]

Authorizations:

None

path Parameters

id

required

string

Request Body schema: application/json
required

schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"
vin	string
vehicleId	string
createdOn	string <date-time>
updatedOn	string <date-time>
productionDate	string <date-time>
soldRegion	string
saleDate	string
	object (VehicleAttributes)
	Array of objects (User)
	object (ModemInfo)
vehicleArchType	string
	object
dummy	boolean
	object
	object
	object (VehicleCapabilities)
	object (SaleAttributes)
eolValidationInProgress	boolean
blockEnrollment	boolean
	object
epiddbChecksum	string
connectedPlatform	string
lastUpdatedTime	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"schemaVersion": "1.0",
"vin": "string",
"vehicleId": "string",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"productionDate": "2019-08-24T14:15:22Z",
"soldRegion": "string",
"saleDate": "string",
"vehicleAttributes": {"make": "string",
"model": "string",
"marketingColor": "string",
"baseColor": "string",
"modelYear": "string",
"destinationCountry": "string",
"engineType": "string",
"bodyStyle": "string",
"bodyType": "string",
"name": "string",
"trim": "string",
"type": "string",
"fuelType": 0
},
"authorizedUsers": [{"userId": "string",
"role": "string",
"source": "string",
"status": "string",
"tc": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"pp": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"modemInfo": {"eid": "string",
"iccid": "string",
"imei": "string",
"msisdn": "string",
"imsi": "string"
},
"vehicleArchType": "string",
"ecus": {"property1": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
},
"property2": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
}
},
"dummy": true,
"events": {"property1": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
},
"property2": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
}
},
"customParams": {"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"vehicleCapabilities": {"sourceType": "string",
"pids": ["string"
],
"useCases": ["string"
]
},
"saleAttributes": {"dealerCode": "string",
"saleDate": "2019-08-24T14:15:22Z",
"eventType": "string",
"eventDate": "2019-08-24T14:15:22Z",
"warrantyStartDate": "2019-08-24T14:15:22Z",
"marketCode": "string",
"salesChannel": "string",
"customerSegment": "string"
},
"eolValidationInProgress": true,
"blockEnrollment": true,
"authorizedPartners": {"property1": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
},
"property2": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
}
},
"epiddbChecksum": "string",
"connectedPlatform": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z"
}

vin-decode-controller

POST /v1/vins/{vinId}/decode

vin-decode-controller-decodeVin

SCOPE: [IgniteSystem]

Authorizations:

None

path Parameters

vinId

required

string

query Parameters

type	string Enum: "DEFAULT" "CODE_VALUE" "POSITION_MATCHER" "VEHICLE_SPECIFICATION"
region	string Enum: "USA" "JAPAN" "INDONESIA" "THAILAND"

Responses

vehicle-profile-controller-v-1

POST /v1/vehicleProfiles/filter

vehicle-profile-controller-v-1-filter

SCOPE: [IgniteSystem]

Authorizations:

None

query Parameters

required

object

Request Body schema: application/json

vin

string

Responses

Request samples

Payload

Content type

application/json

{"vin": "string"
}

vehicles-controller

POST /v1.0/vehicles/{vehicleId}/associate

vehicles-controller-associate

SCOPE: [IgniteSystem]

Authorizations:

None

path Parameters

vehicleId

required

string

Request Body schema: application/json
required

userId	string
role	string
source	string
status	string
	object
	object
createdOn	string <date-time>
updatedOn	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"role": "string",
"source": "string",
"status": "string",
"tc": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"pp": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}

PATCH /v1.0/vehicles/{vehicleId}

vehicles-controller-update

SCOPE: [AssociateMyselfToVehicle,SelfManage]

Authorizations:

None

path Parameters

vehicleId

required

string

Request Body schema: application/json
required

schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"
vin	string
vehicleId	string
createdOn	string <date-time>
updatedOn	string <date-time>
productionDate	string <date-time>
soldRegion	string
saleDate	string
	object (VehicleAttributes)
	Array of objects (User)
	object (ModemInfo)
vehicleArchType	string
	object
dummy	boolean
	object
	object
	object (VehicleCapabilities)
	object (SaleAttributes)
eolValidationInProgress	boolean
blockEnrollment	boolean
	object
epiddbChecksum	string
connectedPlatform	string
lastUpdatedTime	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"schemaVersion": "1.0",
"vin": "string",
"vehicleId": "string",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"productionDate": "2019-08-24T14:15:22Z",
"soldRegion": "string",
"saleDate": "string",
"vehicleAttributes": {"make": "string",
"model": "string",
"marketingColor": "string",
"baseColor": "string",
"modelYear": "string",
"destinationCountry": "string",
"engineType": "string",
"bodyStyle": "string",
"bodyType": "string",
"name": "string",
"trim": "string",
"type": "string",
"fuelType": 0
},
"authorizedUsers": [{"userId": "string",
"role": "string",
"source": "string",
"status": "string",
"tc": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"pp": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"modemInfo": {"eid": "string",
"iccid": "string",
"imei": "string",
"msisdn": "string",
"imsi": "string"
},
"vehicleArchType": "string",
"ecus": {"property1": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
},
"property2": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
}
},
"dummy": true,
"events": {"property1": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
},
"property2": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
}
},
"customParams": {"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"vehicleCapabilities": {"sourceType": "string",
"pids": ["string"
],
"useCases": ["string"
]
},
"saleAttributes": {"dealerCode": "string",
"saleDate": "2019-08-24T14:15:22Z",
"eventType": "string",
"eventDate": "2019-08-24T14:15:22Z",
"warrantyStartDate": "2019-08-24T14:15:22Z",
"marketCode": "string",
"salesChannel": "string",
"customerSegment": "string"
},
"eolValidationInProgress": true,
"blockEnrollment": true,
"authorizedPartners": {"property1": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
},
"property2": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
}
},
"epiddbChecksum": "string",
"connectedPlatform": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z"
}

GET /v1.0/vehicles

vehicles-controller-search

SCOPE: [AssociateMyselfToVehicle,SelfManage]

Authorizations:

None

query Parameters

required

object

Responses

vehicles-controller-v-2

PATCH /v2/vehicles/{vehicleId}

vehicles-controller-v-2-update

SCOPE: [AssociateMyselfToVehicle,SelfManage]

Authorizations:

None

path Parameters

vehicleId

required

string

Request Body schema: application/json
required

schemaVersion	string Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5" "1.6" "1.7" "1.8" "1.9" "2.0" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "3.0" "3.1" "3.2" "3.3" "3.4" "3.5" "3.6" "3.7" "3.8" "3.9" "4.0" "4.1" "4.2" "4.3" "4.4" "4.5" "4.6" "4.7" "4.8" "4.9" "5.0" "5.1" "5.2" "5.3" "5.4" "5.5" "5.6" "5.7" "5.8" "5.9" "6.0" "6.1" "6.2" "6.3" "6.4" "6.5" "6.6" "6.7" "6.8" "6.9" "7.0" "7.1" "7.2" "7.3" "7.4" "7.5" "7.6" "7.7" "7.8" "7.9" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5" "8.6" "8.7" "8.8" "8.9" "9.0" "9.1" "9.2" "9.3" "9.4" "9.5" "9.6" "9.7" "9.8" "9.9"
vin	string
vehicleId	string
createdOn	string <date-time>
updatedOn	string <date-time>
productionDate	string <date-time>
soldRegion	string
saleDate	string
	object (VehicleAttributes)
	Array of objects (User)
	object (ModemInfo)
vehicleArchType	string
	object
dummy	boolean
	object
	object
	object (VehicleCapabilities)
	object (SaleAttributes)
eolValidationInProgress	boolean
blockEnrollment	boolean
	object
epiddbChecksum	string
connectedPlatform	string
lastUpdatedTime	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"schemaVersion": "1.0",
"vin": "string",
"vehicleId": "string",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"productionDate": "2019-08-24T14:15:22Z",
"soldRegion": "string",
"saleDate": "string",
"vehicleAttributes": {"make": "string",
"model": "string",
"marketingColor": "string",
"baseColor": "string",
"modelYear": "string",
"destinationCountry": "string",
"engineType": "string",
"bodyStyle": "string",
"bodyType": "string",
"name": "string",
"trim": "string",
"type": "string",
"fuelType": 0
},
"authorizedUsers": [{"userId": "string",
"role": "string",
"source": "string",
"status": "string",
"tc": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"pp": {"property1": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
},
"property2": {"name": "string",
"status": "string",
"countryCode": "string",
"version": "string",
"lastAcceptedOn": "2019-08-24T14:15:22Z",
"endOfAcceptance": "2019-08-24T14:15:22Z",
"offset": 0
}
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"modemInfo": {"eid": "string",
"iccid": "string",
"imei": "string",
"msisdn": "string",
"imsi": "string"
},
"vehicleArchType": "string",
"ecus": {"property1": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
},
"property2": {"swVersion": "string",
"hwVersion": "string",
"partNumber": "string",
"os": "string",
"screenSize": "string",
"manufacturer": "string",
"ecuType": "string",
"serialNo": "string",
"clientId": "string",
"capabilities": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"provisionedServices": {"services": [{"applicationId": "string",
"version": "string"
}
]
},
"inventory": {"property1": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
},
"property2": {"property1": {"scomo_id": "string",
"version": "string"
},
"property2": {"scomo_id": "string",
"version": "string"
}
}
}
}
},
"dummy": true,
"events": {"property1": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
},
"property2": {"eventId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"lastReceivedOn": "2019-08-24T14:15:22Z"
}
},
"customParams": {"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"vehicleCapabilities": {"sourceType": "string",
"pids": ["string"
],
"useCases": ["string"
]
},
"saleAttributes": {"dealerCode": "string",
"saleDate": "2019-08-24T14:15:22Z",
"eventType": "string",
"eventDate": "2019-08-24T14:15:22Z",
"warrantyStartDate": "2019-08-24T14:15:22Z",
"marketCode": "string",
"salesChannel": "string",
"customerSegment": "string"
},
"eolValidationInProgress": true,
"blockEnrollment": true,
"authorizedPartners": {"property1": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
},
"property2": {"partnerId": "string",
"serviceClaims": {"property1": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
},
"property2": {"start": "2019-08-24T14:15:22Z",
"expire": "2019-08-24T14:15:22Z"
}
}
}
},
"epiddbChecksum": "string",
"connectedPlatform": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z"
}

GET /v2/vehicles

vehicles-controller-v-2-search

SCOPE: [AssociateMyselfToVehicle,SelfManage]

Authorizations:

None

query Parameters

required

object

Responses

user-controller-v-2

GET /v2/users/{userId}/associatedVehicles

user-controller-v-2-getAssociatedVehicles

SCOPE: [SelfManage,VehicleProfile]

Authorizations:

None

path Parameters

userId

required

string

query Parameters

pageNumber	string
pageSize	string
sortby	string
orderby	string

Responses

user-controller

GET /v1.0/users/{userId}/associatedVehicles

user-controller-getAssociatedVehicles

SCOPE: [SelfManage,VehicleProfile]

Authorizations:

None

path Parameters

userId

required

string

Responses

user-associated-vehicles-controller

GET /v1.0/associatedVehicles

user-associated-vehicles-controller-getAssociatedVehicles

SCOPE: [SelfManage]

Authorizations:

None

ASSOCIATION-API (1)

association-controller

PUT v1/user/device/vin

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

PUT v1/devices/item

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST v3/user/devices/associate/

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

POST v2/user/associations/terminate

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST v1/user/associations/wipe

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

POST v1/sim/suspend

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST /v1/associations

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST /v1/associations/terminate

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST v1/associations/self

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST /v1/associations/self/terminate

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST /v1/associations/delegation

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

GET v3/user/associations/

Authorizations:

Responses

device-association-rest-service

PUT /v1/user/device/state

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

POST v2/user/devices/associate/

Authorizations:

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required