Skip to main content
Omnitracs Knowledge Base

Retrieve Vehicle Group Membership - OMRTVGRP

Retrieve Vehicle Group Membership (OMRTVGRP) RI

Required Parameter Group:

1 Vehicle ID Input Char(10)
2 Group Block Output Char(300)
3 Return Status Output Char(2)

API Overview:
The Retrieve Vehicle Group Membership API is used to determine all of the vehicle message groups that a specified vehicle is a member of. This API retrieves the list of vehicle message groups from a host database. The host does not query the NMC to retrieve this information.

\Required Parameter Group Details:
(1) Vehicle ID
INPUT; CHAR(10)
This parameter specifies the vehicle to determine group membership for.

(2) Group Block
OUTPUT; CHAR(300)
Parameters returned to the caller will be in block form as follows:

1-10 Group Member 1 Char(10)
11-20 Group Member 2 Char(10)
21-30 Group Member 3 Char(10)
31-40 Group Member 4 Char(10)
41-300 Reserved

( 3 ) Return Status
OUTPUT; CHAR(2)
Status value returned to the caller will be set as follows:

0 0 Success, group membership returned
01 Failure, invalid vehicle ID
  • Was this article helpful?