Skip to main content
Omnitracs Knowledge Base

VehicleMembershipData

 

Vehicle Membership Data objects are implemented as the VehicleMembershipData class. A VehicleMembershipData object contains information that uniquely identifies the vehicle, along with the vehicle membership data. This includes membership to Coverages, Global Groups, and Vehicle Message Groups. The attributes of a VehicleMembershipData object are:

 

Attribute

 

 

Description

 

id

A string of maximum length 10 that contains the identifier of the vehicle. This is usually set to the value of the tractor decal.

ua

The unit address of the mobile device that is installed in this vehicle. This uniquely identifies the vehicle.

vin

A string of exactly 17 characters containing the VIN of the vehicle. Characters I, O, Q are not permitted.

coverage

A string containing the identifier of the user or group of users who are responsible for monitoring message traffic from this vehicle. This person or group of people is referred to as the vehicle's coverage. A group of users is referred to as an address list.

vmg [ ]

Vehicle Message Group array. An array of Strings that identify the broadcast message groups to which this vehicle is assigned. A broadcast message group is a group of vehicles to which messages may be addressed in broadcast mode. The single transmission of a message addressed to a broadcast message group causes the message to be received by all vehicles that are currently members of the group.

gg [ ]

Global Group ID array. An array of Strings that identify the global groups to which this vehicle is a member.

 

WSDL Definition

 

Below is how the Vehicle Membership Data object is defined in the WSDL

<complexType name="VehicleMembershipData">

    <sequence>

        <element name="id" nillable="true" type="xsd:string"/>

        <element name="ua" nillable="true" type="xsd:string"/>

        <element name="vin" nillable="true" type="xsd:string"/>

        <element name="coverage" nillable="true" type="xsd:string"/>       

        <element name="vmg" nillable="true" type="impl:ArrayOf_tns2_nillable_String"/>

        <element name="gg" nillable="true" type="impl:ArrayOf_tns2_nillable_String"/>

    </sequence>

</complexType>

 

Sample XML

 

Here is some sample XML that shows what the Vehicle Membership Data object will look like in XML.

<VehicleMembershipData>

   <id>ATOM92426</id>

   <ua>0123456789</name>

   <vin>1G6CD5183H4333111</vin>

   <coverage>COVERAGE12</coverage>

   <vmg>

        <string>GROUP1</string>

        <string>GROUP2</string>

   </vmg>

   <gg>

        <string>GlobalGroup1</string>

        <string>GlobalGroup2</string>

   </gg>

</VehicleMembershipData>

  • Was this article helpful?