TTIA Send Configuration 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 edit TTIA settings' on the Customer portal.
Calling Interface
SendConfigurationsResponse sendConfigurations (SendConfigurationsRequest sendMessages) throws WSException
- sendConfigurations: The SendConfigurationsRequest encapsulates the information required to send TTIA configurations to the mobiles. Please see below of a description of the necessary fields required for TTIA configuration.
- returns SendConfigurationsResponse
- The response indicates the successful acceptance of the TTIA Configuration for processing. Status of the mobile configuration can be queried by calling getCurrentConfiguration.
SendConfigurationsRequest
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Routing |
Contains the routing information for this message. The Primary Service Id should be set to 'VM' and 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 Unified Address will take higher precedence. |
Yes |
|
Configuration |
SendConfigurationType |
Container for TTIA Configuration Set. |
Yes |
Configuration (SendConfigurationType)
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Configuration |
ConfigurationResourceType |
Customer supplied tracking id. The maximum size of a correlation Id is 100 characters. |
Yes |
Action |
ActionType |
|
No |
Resource |
BaseResourceType |
|
No |
Created |
dateTime |
|
No |
ConfigurationResourceType
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Resource |
BaseResourceType |
Only Type is required. |
Yes |
Payload |
PayloadType |
The container for TTIA Configuration payload. |
Yes |
PayloadType
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
Type |
Type |
Text |
Yes |
Text |
String |
The text is in xml format. The xml must conform payload.xsd.
|
Yes |
Sample XML Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
SendMessagesResponse
Element
|
Type
|
Description
|
Required
|
---|---|---|---|
SendMessageAck |
IncomingAckType |
Acknowledgement Status for each message sent in the request |
Yes |
Sample XML Response
This example shows the response to a successful send TTIA configuration request
|