Skip to main content
Omnitracs Knowledge Base

Company

Information about a company is implemented in the Company object. The attributes of the Company object are:

 

Attribute

 

 

Description

 

address

A string of maximum length 40 containing the street address of the place.

address2

A string of maximum length 40 containing an additional street address of the place.

alertRetention

An integer value representing the company's preference for alert purge time in days.

city

A string of maximum length 40 containing the city of the place.

country

A string of maximum length 5 containing the country code of the place.
Valid values are:
CA - Canada
CO - Colombia
MX - Mexico
PE - Peru
US - United States
VE - Venezuela

custAcctNo

A string of maximum length 10 indicating the company's numeric Customer Account Number at the NMC.

custAuxAcctNo

A string of maximum length 10 indicating the company's numeric Auxiliary Customer Account Number at the NMC. It is associated with the Customer Account Number.

hubId

A string of maximum length 3 that identifies the decimal representation of the NMC Family/Instance to which the company is connected/associated.
Valid values are:
1 - U.S. Omnitracs
17 - Europe EutelSat
22 - Europe GPRS
33 - Mexico CNR
65 - Brazil AutoTRACS
81 - Canada Shaw
150 - MGW150
157 - MGW157
159 - MGW159
160 - MGW160
161 - MGW161
163 - MGW163
164 - MGW164
9 - MGW165
166 - MGW166
7 - MGW167
8 - MGW168
172 - MGW172
174 - MGW174
175 - MGW175
190 - MGW190
30 - MGW300
5 - MGW500

id

A string value of maximum length 10 indicating the unique identifier of the company.

lockedOut

A boolean value indicating if the company has been locked out.

name

A string value of maximum length 50 indicating the name of the company.

obeyDst

A boolean value indicating if the company obeys daylight saving time.

ownAcctNo

A string of maximum length 10 representing the company's numeric Owning Account Number at the NMC. This should only be specified when the Customer Account Number is not the primary NMC account number for the company.

ownAuxAcctNo

A string of maximum length 10 representing the company's numeric Auxiliary Account Number at the NMC for the Owning Account Number. It is associated with the Owning Account Number. This should only be specified when the Owning Account Number is used.

postalCode

A string of maximum length 12 containing the postal code of the place.

qspInstance

A character value representing the instance of the Portal the user belongs to. Valid values are:
"1" - Qualcomm (US)
"2" - Shaw (CA)
"3" - CNR (MX)

reportRetention

An integer value representing the company's preference for report purge time in days.

state

A string of maximum length 2 containing the state of the place.

tempUom

A character value representing the unit of measure for temperature used by a company.
Valid values are:
F - Fahrenheit
C - Celsius

timeZone

TimeZone object containing information about the company's timezone settings.

timeZonesObserved

A string of maximum length 2 indicating the subset list of timezones that are applicable to the company.
Valid values at this time are:
US - United States
CA - Canada
MX - Mexico
CO - Colombia
PE - Peru
VE - Venezuela

uom

A string of maximum length 10 representing the unit of measure used by a company.
Valid values are:
US
Metric
Imperial

WSDL Definition

Here is how the Company Information object is defined within the WSDL

<complexType name="Company">

   <sequence>

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

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

      <element name="alertRetention" type="xsd:int"/>

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

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

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

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

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

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

      <element name="lockedOut" type="xsd:boolean"/>

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

      <element name="obeyDst" type="xsd:boolean"/>

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

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

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

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

      <element name="reportRetention" type="xsd:int"/>

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

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

      <element name="timeZone" nillable="true" type="tns2:TimeZone"/>

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

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

   </sequence>

</complexType>




 

Sample XML

Here is some sample XML that shows what the User Information object will look like in XML

<company>

   <address>5775 Morehouse Drive</address>

   <address2/>

   <alertRetention>14</alertRetention>

   <city>San Diego</city>

   <country>US</country>

   <custAcctNo>12345678</custAcctNo>

   <custAuxAcctNo>12345679</custAuxAcctNo>

   <hubId>1</hubId>

   <id>MYCOMPANY</id>

   <lockedOut>0</lockedOut>

   <name>My Company, Inc.</name>

   <obeyDst>1</obeyDst>

   <ownAcctNo/>

   <ownAuxAcctNo/>

   <postalCode>92121</postalCode>

   <qspInstance>1</qspInstance>

   <reportRetention>7</reportRetention>

   <state>CA</state>

   <tempUom>F</tempUom>

   <timeZone>

      <dstLongName>Pacific Daylight Saving Time</dstLongName>

      <dstShortName>PDT</dstShortName>

      <gmtOffset>GMT-08:00</gmtOffset>

      <name>Pacific Time</name>

      <stdLongName>Pacific Standard Time</stdLongName>

      <stdShortName>PST</stdShortName>

   </timeZone>

   <timeZonesObserved>US</timeZonesObserved>

   <uom>US</uom>

</company>

  • Was this article helpful?