HOS Create Depot

Available in PIT v2.3

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

API Name: HSDEPCR

Parameter Interface:

Parameter	Direction	Type	Length	Precision	Description
Create Depot	Input	DS	n/a	n/a	See the Create Depot 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 depot was created successfully and the assigned Depot ID has been returned in the structure.

Create Depot Structure (HSDEPCRDS):

This DS is used by the caller of the HOS Create Depot 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
DepotId	Character Varying	100	n/a	Optional depot ID; when blank an ID is assigned
DepotName	Character Varying	100	n/a	Always required
TimeZone	Character Varying	100	n/a	Always required
StartOfDay	Character Varying	100	n/a	Optional start of day time in mins from midnight; when blank it is set to midnight
Street	Character Varying	100	n/a	Always required
Street2	Character Varying	100	n/a	Always required
City	Character Varying	100	n/a	Always required
State	Character Varying	100	n/a	Always required
Postal	Character Varying	100	n/a	Always required