Navixy Web Service

SOAP endpoint for requesting tracking data for a specified period

Protocol Category: Data consolidation protocol

Table of contents

1. What is Navixy Web Service?

2. Technical information about Navixy Web Service

3. Navixy Web Service Configuration

4. Setting up

5. Managing

6. Troubleshooting

What is Navixy Web Service?

Navixy Web Service data forwarding protocol transmits fleet data from the Navixy system to any third-party system. The protocol is flexible, allowing third parties to store fleet data in their databases to use for any purposes or to display data on the web resources.

Since this data forwarding protocol is platform agnostic, it would be the ideal option for any partner that works with XML files.

Navixy Web Service general technical information

The Navixy Web Service protocol utilizes SOAP to allow the pulling of XML data from tracking devices as part of the OSI application layer. Data is pulled on demand.

Data fields that are sent:

• dateGPS: Date and time in UTC

• ignition: Boolean ignition status

• latitude

• longitude

• speedGPS: km/h

• unitPlate: License plate

• altitude: Meters

• course: Vehicle direction, for example: N,S,E,O,NO,NE,SO,SE

• deviceId: IMEI

• numSat: Number of GNSS satellites the device is utilizing

• odometer: Traveled distance in km

• eventId: the event code according to the Navixy Generic Protocol's event ID

Navixy Web Service Configuration

Setting up

To set up data forwarding in Navixy Web Service protocol:

1. Go to Devices and settings from the left sidebar.

2. Select the needed device from the Objects list.

3. Find the Data forwarding portlet, expand it and click .

4. In the opened window, click "+" to add a new retranslation.

5. In the New retranslation protocol dialog, input the required information. For Navixy Web Service protocol, fill in the following fields:

Parameter	Explanation
Name	A descriptive label to identify this retranslation protocol configuration. Enter a name to make this retranslator easily identifiable.
Protocol and Login	The communication protocol used for retranslation. Select Navixy Web Service from the dropdown menu.
Address	The URL or IP address of the destination server. Note: It is not used by Navixy Web Service, enter any valid address format.
Port	The network port for connecting to the destination server. Note: It is not used by Navixy Web Service, enter any port number.
Login	A unique identifier for this retranslator connection. Enter any login that isn't already used by another retranslator in your system.
Password	Authentication passcode for this retranslator connection. Enter a unique password to secure this retranslator configuration.

1. Toggle the Enabled switch on to activate data retranslation. The retranslator will not transmit any data while disabled.

2. The Retranslation management screen should look similar to the following, with the Navixy Web Service login and password. Make sure the status is Active if you want this retranslator to sebd data.

3. Next, the retranslator will need to be linked to the device. To do so, enable the toggle with the needed retranslator name in the Data forwarding portlet. External ID is not needed for the Navixy Web Service protocol.

You successfully created and enabled a new retranslation protocol for this device. Now the retranslator is available for all devices in the account, you canenable it by switching the toggle in other devices settings.

External access:

Required parameters:

• Login and password: These should match the credentials you set up in the retranslator configuration

• deviceIDs: Max of 100

• startDate and endDate: For example, September 9, 2022 12am UTC to 11:59:59

  • UTC: 2022-09-01T00:00:00Z to 2022-09-01T11:59:59Z

The description of the protocol in WSDL can be found below, relating to where the server is located:

EU https://soap.navixy.com/LocationDataService?wsdl

US https://soap.us.navixy.com/LocationDataService?wsdl

A SOAP request must be made utilizing one of the above WSDL pages. The XML request itself is as follows, replaced with the associated information:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org">

   <soapenv:Header>
   <tem:authentication>
     <login>username</login>
     <password>password</password>
   </tem:authentication>
   </soapenv:Header>
   <soapenv:Body>
   <tem:dataRequest>
      <!--1 to 100 repetitions:-->
      <deviceIds>IMEI of device</deviceIds>
      <startDate>2022-08-30T00:00:00Z</startDate>
      <endDate>2022-08-31T00:00:00Z</endDate>
   </tem:dataRequest>
   </soapenv:Body>
</soapenv:Envelope>

An example response may look like this:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns:getLocationDataResponse xmlns:ns="http://tempuri.org">
            <result>
                <dateGps>2019-10-15T08:48:50.000Z</dateGps>
                <ignition>false</ignition>
                <latitude>75.9270866</latitude>
                <longitude>-85.5207616</longitude>
                <speedGps>0.0</speedGps>
                <unitPlate>JRT1550</unitPlate>
                <altitude>284.0</altitude>
                <course>N</course>
                <deviceId>866258048802349</deviceId>
                <numSat>15</numSat>
                <odometer>59845</odometer>
                <eventId>401</eventId>
            </result>
        </ns:getLocationDataResponse>
    </S:Body>
</S:Envelope>

Managing

To edit or stop data being forwarded, follow this steps steps:

1. In any Data forwarding portlet, click to open the list of available protocols.

2. Click to change retranslator settings such as name, login information, or enabled status.

3. Click and confirm to delete a retranslator

All changes are saved automatically.

To enable/disable a retranslator for a certain device, switch the toggle with the needed retranslator name in the device's Data forwarding portlet.

Troubleshooting

In order to verify and test your SOAP request to the platform, it is suggested to use SoapUI which can be found here: https://www.soapui.org/downloads/soapui/

1. Install Soap UI

2. From the file menu, select “New SOAP Project”

3. Paste the correct path into the WSDL field according to the server and select Create sample requests for all operations?

4. US: https://soap.us.navixy.com/LocationDataService?wsdl

5. EU: https://soap.navixy.com/LocationDataService?wsdl