High Mobility Push API 1.0.0
This document specifies the JSON format for each vehicle property that is made available through High Mobility's streaming and push interfaces.
SUB {instance}/{auto_api_level}/{app_id}/{vin}/wi_fi/{action}/{property}
Operation IDliveinstancerequiredstringuid: instancelive/sandbox
- Allowed values:
- "live"
- "sandbox"
auto_api_levelrequiredstringuid: auto_api_levelAutoAPI level
Const:"level13"app_idrequiredstringuid: app_idApplication id
vinrequiredstringuid: vinVIN
capabilityrequiredstringuid: capabilityCapability
Const:"wi_fi"actionrequiredstringuid: actionAction
Const:"get"propertyrequiredstringuid: propertyProperty
qos1Accepts one of the following messages:
- #0Wi Fi Network Connectedobjectuid: wi_fi_get_network_connectedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_connected"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Network connected
datarequiredstringConnection state
- Allowed values:
- "disconnected"
- "connected"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "wi_fi", "property": "network_connected", "data": { "wi_fi": { "network_connected": { "data": "connected", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #1Wi Fi Network Securityobjectuid: wi_fi_get_network_securityversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_security"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Network security
datarequiredstringNetwork security
- Allowed values:
- "none"
- "wep"
- "wpa"
- "wpa2_personal"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "wi_fi", "property": "network_security", "data": { "wi_fi": { "network_security": { "data": "wpa2_personal", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #2Wi Fi Network Ssidobjectuid: wi_fi_get_network_ssidversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_ssid"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
The network SSID
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "wi_fi", "property": "network_ssid", "data": { "wi_fi": { "network_ssid": { "data": "Excepteur mollit cillum amet", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #3Wi Fi Statusobjectuid: wi_fi_get_statusversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"status"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Status
datarequiredstringEnabled state
- Allowed values:
- "disabled"
- "enabled"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "wi_fi", "property": "status", "data": { "wi_fi": { "status": { "data": "disabled", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #1Wi Fi Network Connectedobjectuid: wi_fi_get_network_connectedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_connected"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Network connected
datarequiredstringConnection state
- Allowed values:
- "disconnected"
- "connected"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #2Wi Fi Network Securityobjectuid: wi_fi_get_network_securityversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_security"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Network security
datarequiredstringNetwork security
- Allowed values:
- "none"
- "wep"
- "wpa"
- "wpa2_personal"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #3Wi Fi Network Ssidobjectuid: wi_fi_get_network_ssidversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_ssid"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
The network SSID
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #4Wi Fi Statusobjectuid: wi_fi_get_statusversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"status"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Status
datarequiredstringEnabled state
- Allowed values:
- "disabled"
- "enabled"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: wi_fi_get_network_connectedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_connected"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Network connected
datarequiredstringConnection state
- Allowed values:
- "disconnected"
- "connected"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: wi_fi_get_network_securityversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_security"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Network security
datarequiredstringNetwork security
- Allowed values:
- "none"
- "wep"
- "wpa"
- "wpa2_personal"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: wi_fi_get_network_ssidversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"network_ssid"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
The network SSID
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: wi_fi_get_statusversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"wi_fi"propertyrequiredstringConst:"status"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Status
datarequiredstringEnabled state
- Allowed values:
- "disabled"
- "enabled"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.