Get Sent Configuration Status Webservice Details
Authorization Requirements
The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.
Required Application Licenses
- Vehicle Maintenance
The user must also have been granted the capability 'Can query TTIA settings' on the Customer portal.
Calling Interface
GetCurrentConfigurationResponse getCurrentConfiguration (GetCurrentConfigurationRequest getRequests) throws WSException
- getCurrentConfiguration: The GetCurrentConfigurationRequest encapsulates the information required to query for last known TTIA alert configuration status on the mobile
- returns GetCurrentConfigurationResponse
- Indicates the TTIA alert settings and the status
GetCurrentConfigurationRequest
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Routing |
Contains the routing information for this message. The Primary Service Id should be set to 'VM', the secondary service Id should be set to 'TTIACONFIGURATION' the Destination should be filled in with the Vehicle Unified Address, and/or Vehicle Id. If both Vehicle Unified Address and Vehicle Id are present, Vehicle Id will take higher precedence. |
Yes |
Sample XML Requests
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
This sample asks for TTIA configuration for vehicle UA 105375593.
|
GetCurrentConfigurationResponse
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Configuration |
ConfigurationType |
List of Mobiles and the configuration and the status for each mobile. |
Yes |
ConfigurationType
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Routing |
Contains the information about how the message was routed |
Yes |
|
Configuration |
ConfigurationResourceType |
Container for actual payload in the message |
No |
Status |
ConfigurationStatusType |
Message creation time |
Yes |
Resources |
AssociatedResourceType |
Any additional information about the creation and changes to the message |
No |
MetaData |
NameValueType |
Any additional information about the creation and changes to the message |
No |
ConfigurationStatusType
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
State |
ConfigurationStateType |
The state of configuration. The possible values are Pending/Failed/Delivered/Unknown/NoValue |
Yes |
StateTime |
dateTime |
When the state is updated. |
No |
Reason |
string |
Detail reason why the mobile has this state. |
No |
Sample XML Response
The sample XML response shows the TTIA configuration with delivered state for vehicle 106017282.
|