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	RoutingType	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

Element

Type

Description

Required

Routing

RoutingType

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

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. Each TTIA configuration payload contains up to 5 TTIA Alert configurations. If there are more than 5 TTA alert configurations, an error message of WSException: Configuration Payload parsing error:cvc-complex-type.2.4.d: Invalid content was found starting with element 'TTIAAlertConfiguration'. No child element is expected at this point." will be returned. For each TTIA alert configurations, thefollowing constraints must be met. Label can not be empty and no two labels can be the same within one TTIA Configuration payload No two TTI alert configurations can be the same excluding labels within one TTIA configuration payload. AlertType is either 'Non-Critical' or 'Critical 15 <= EventDurationThreshold <=1800 0 <= EventCount <= 10 30 <= AlertDurationThreshold <=604800 AlertDurationThreshold >= EventDurationThresholdEventCount+ 120 (EventCount -1)	Yes

Element

Type

Description

Required

Type

Text

Yes

Text

String

The text is in xml format. The xml must conform payload.xsd.
Each TTIA configuration payload contains up to 5 TTIA Alert configurations. If there are more than 5 TTA alert configurations, an error message of WSException: Configuration Payload parsing error:cvc-complex-type.2.4.d: Invalid content was found starting with element 'TTIAAlertConfiguration'. No child element is expected at this point." will be returned.

For each TTIA alert configurations, thefollowing constraints must be met.

Label can not be empty and no two labels can be the same within one TTIA Configuration payload
No two TTI alert configurations can be the same excluding labels within one TTIA configuration payload.
AlertType is either 'Non-Critical' or 'Critical
15 <= EventDurationThreshold <=1800
0 <= EventCount <= 10
30 <= AlertDurationThreshold <=604800
AlertDurationThreshold >= EventDurationThreshold*EventCount+ 120 * (EventCount -1)

Yes

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soapenv:Envelope xmlns:ns="http://cfg.data.eip.omnitracs.com/1.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<ns:SendConfigurationsRequest>

<Routing>

<Destination>

<Type>Vehicle</Type>

<SystemAssignedId>123</SystemAssignedId>

</Destination>

<Service>

<Primary>

<Id>VM</Id>

</Primary>

</Service>

</Routing>

<Configuration>

<Resource>

<Type>Vehicle</Type>

</Resource>

<Payload>

<Type>Text</Type>

<Text>

<![CDATA[

<tns:ConfigurationPayload xmlns:tns="http://www.omnitracs.com/TPMInput" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.omnitracs.com/TPMInput ConfigurationPayload.xsd ">

<TTIAConfigurationPayload>

<TTIAAlertConfiguration>

<Label>label 1</Label>

<AlertType>Non-Critical</AlertType>

<EventDurationThreshold>30</EventDurationThreshold>

<EventCount>5</EventCount>

<AlertDurationThreshold>30000</AlertDurationThreshold>

</TTIAAlertConfiguration>

<TTIAAlertConfiguration>

<Label>Lable 2</Label>

<AlertType>Critical</AlertType>

<EventDurationThreshold>30</EventDurationThreshold>

<EventCount>5</EventCount>

<AlertDurationThreshold>32000</AlertDurationThreshold>

</TTIAAlertConfiguration>

</TTIAConfigurationPayload>

</tns:ConfigurationPayload>

]]>

</Text>

</Payload>

</Configuration>

</ns:SendConfigurationsRequest>

</soapenv:Body>

</soapenv:Envelope>

SendMessagesResponse

Element	Type	Description	Required
SendMessageAck	IncomingAckType	Acknowledgement Status for each message sent in the request	Yes

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

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<ns4:SendConfigurationsResponse xmlns:ns4="http://cfg.data.eip.omnitracs.com/1.0" xmlns:ns3="http://res.data.eip.omnitracs.com/1.0" xmlns:ns5="http://base.data.eip.omnitracs.com/1.0"/>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>