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

GetSentMessageResponse getSentMessage (GetSentMessageRequest getMessage) throws WSException

getMessage: The GetSentMessageRequest encapsulates the information required to query for status on the sent CoPilot message
returns GetSentMessageResponse
- Indicates the status of the requests message

GetSentMessageRequest

Element	Type	Description	Required
Id	IdType	Indicate the key of the message to query the status. The Key must be filled into the Id element.	Yes

Element

Type

Description

Required

Id

IdType

Indicate the key of the message to query the status. The Key must be filled into the Id element.

Yes

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:GetSentMessageRequest 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 ">

<Id>

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

</Id>

</msgEip:GetSentMessageRequest>

</soap:Body>

GetSentMessageResponse

Element	Type	Description	Required
Message	IncomingMessageType	List of Messages. WIll have one message if it is found, and will be empty if none are found.	Yes

Element

Type

Description

Required

Message

IncomingMessageType

List of Messages. WIll have one message if it is found, and will be 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 GetSentMessageRequest.

<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