Skip to main content
Omnitracs Knowledge Base

HOS Add Carrier

add.pngAvailable in PIT v2.3

This ILE API wraps the Add HOS Carrier Web Service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.

API Name: HSCARCR

Parameter Interface:

Parameter

Direction

Type

Length

Precision

Description

Create Carrier

Input

DS

n/a

n/a

See the Create Carrier structure below

Error Category

Output

Decimal

3

0

Error Category, if any

Error Code

Output

Decimal

5

0

Error Code, if any

Error Description

Output

Character

150 varying

n/a

Error description, if any

An error category of 0 means that the creation of the carrier was successful.

Create Carrier Structure (HSCARCRDS):

This DS is used by the caller of the HOS Create Carrier web service wrapper to optionally specify one or more fields upon creation.

The caller MUST initialize (clear) the DS prior to use. This will zero the lengths of each field. Fields with zero lengths are considered null and will not be included in the update request sent to the web service.

The caller MUST assign values to each of the required fields. Note that it is up to the caller to ensure the validity of the field values and field combinations. Fields that are optional may be left in their initialized states i.e. zero lengths.

Field

Type

Length

Precision

Description

CarrierName

Character Varying

100

n/a

Always required

Street

Character Varying

100

n/a

Optional

Street2

Character Varying

100

n/a

Optional

City

Character Varying

100

n/a

Optional

State

Character Varying

100

n/a

Optional

Postal

Character Varying

100

n/a

Optional

MiscInfo

Character Varying

256

n/a

Optional

USDOTNumber

Character Varying

100

n/a

Always required

  • Was this article helpful?