Get Sent Messages 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

Copilot
Remote Integration

The user must also have been granted the capability 'Can send CoPilot messages' on the Customer portal.

Calling Interface

GetSentMessagesResponse getSentMessages (GetSentMessagesRequest getMessages) throws WSException

getMessages: The GetSentMessagesRequest encapsulates the information required to query for status on the sent CoPilot messages
returns GetSentMessagesResponse
- Indicates the status of the requests message(s)

GetSentMessagesRequest

Element	Type	Description	Required
DeliveredState	IncomingDeliveredStatesType (string)	Delivery states: Pending, Delivered and Failed	Yes
Routing	RoutingType	Routing information to be able to lookup the type of sent messages (Destination, Service/App, etc...)	Yes
FromKey	string	Provide a way to return messages sent after this message (see SendMessageAck in SendMessageResponse)	No
MaxMessages	int	Maximum number of messages to return - if not included will return all	No
StartDate	dateTime	Start date to focus request	No
EndDate	dateTime	End date for request	No

Sample XML Requests

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
This sample asks for all Pending requests.

<soap:Body>

<msgEip:GetSentMessagesRequest xmlns:baseEip="http://base.data.eip.omnitracs.com/1.0"

xmlns:msgEip="http://msg.data.eip.omnitracs.com/1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://msg.data.eip.omnitracs.com/1.0 EIPMessage1.0.xsd ">

<DeliveredState>Pending</DeliveredState>

<Routing>

<Service>

<Primary>

<Id>CPLT</Id>

</Primary>

</Service>

</Routing>

</msgEip:GetSentMessagesRequest>

</soap:Body>

This sample asks for all Pending requests for a given vehicle.

<soap:Body>

<msgEip:GetSentMessagesRequest xmlns:baseEip="http://base.data.eip.omnitracs.com/1.0"

xmlns:msgEip="http://msg.data.eip.omnitracs.com/1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://msg.data.eip.omnitracs.com/1.0 EIPMessage1.0.xsd ">

<DeliveredState>Pending</DeliveredState>

<Routing>

<Destination>

<Type>Vehicle</Type>

<CustomerAssignedId>MyTruck123</CustomerAssignedId>

</Destination>

<Service>

<Primary>

<Id>CPLT</Id>

</Primary>

</Service>

</Routing>

</msgEip:GetSentMessagesRequest>

</soap:Body>

GetSentMessagesResponse

Element	Type	Description	Required
Message	IncomingMessageType	List of Messages. Empty if none are found.	Yes

Element

Type

Description

Required

Message

IncomingMessageType

List of Messages. Empty if none are found.

Yes

IncomingMessageType

Element	Type	Description	Required
Id	IdType	Contains the unique keys for this message for both customer and platform	Yes
Routing	RoutingType	Contains the information about how the message was routed	Yes
Payload	PayloadType	Container for actual payload in the message	Yes
Created	dateTime	Message creation time	No
AuditHistory	IncomingAuditHistoryType	Any additional information about the creation and changes to the message	Yes

Sample XML Response

The payload is not returned for GetSentMessagesRequest.

<soapenv:Body>

<msgEip:GetSentMessagesResponse xmlns:baseEip="http://base.data.eip.omnitracs.com/1.0"

xmlns:msgEip="http://msg.data.eip.omnitracs.com/1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://msg.data.eip.omnitracs.com/1.0 EIPMessage1.0.xsd ">

<Message>

<Id>

<Key>1111-3333-4444-5555</Key>

<CorrelationId>MyCorrelationId</CorrelationId>

</Id>

<Routing>

<Priority>0</Priority>

<Destination>

<Type>Vehicle</Type>

<CustomerAssignedId>MyTruck123</CustomerAssignedId>

</Destination>

<Service>

<Primary>

<Id>CPLT</Id>

</Primary>

</Service>

</Routing>

<Created>2001-12-31T12:00:00</Created>

<AuditHistory>

<Audit>

<Key>50C7A25A-971E-44F6-90F3-BC894B351FAD</Key>

<Date>2013-05-14T23:44:56.795Z</Date>

<Who>mobile</Who>

<AckStatus>1</AckStatus>

<AckContext>

<UOMType>Omnitracs</UOMType>

<Valid>true</Valid>

<TransmitOrCreate>create</TransmitOrCreate>

<Ignition>On</Ignition>

<Speed>10</Speed>

<Direction>90</Direction>

<PosFixTime>2013-05-14T23:44:56.777Z</PosFixTime>

<Odometer>1234.5</Odometer>

<Latitude>33.123245</Latitude>

<Longitude>-117.235698</Longitude>

</AckContext>

</Audit>

<Audit>

<Key>50C7A25A-971E-44F6-90F3-BC894B351FAD</Key>

<Date>2013-05-14T23:44:51.186Z</Date>

<Who>network</Who>

<AckStatus>1</AckStatus>

<AckContext>

<UOMType>Omnitracs</UOMType>

<Valid>false</Valid>

<TransmitOrCreate>create</TransmitOrCreate>

<Speed>0</Speed>

<Direction>0</Direction>

<Odometer>0</Odometer>

</AckContext>

</Audit>

</AuditHistory>

</Message>

</msgEip:GetSentMessagesResponse>

</soapenv:Body>

Exceptions

0000 - There was a problem with the request, either the XML was invalid, or no soap operation was found.

0001 - Too many web service calls too quickly. Make the request later.

0002 - An Internal Error Occurred when trying to process the request. Please try again later.

0003 - Authentication Failed. Check the user credentials

0004 - Not Authorized (No Authorized Apps found)

0005 - WSSE Header Block missing or invalid

0006 - WSSE Header Username token is missing or invalid

1000 - No Data Found. Was not able to locate a required resource

1001 - Invalid Input, Something missing or incorrect in the request. Exception will indicate what the problem was.

1002 - Internal Error, some unknown error occurred. Retry later or call customer service.

1003 - Not authorized. Not authorized to use this service. Check the User Roles on the customer portal