Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

This function is called to update the quantities of spare types held in an employee’s vehicle (assumed to be a daily replenished value).


 

Definition

The definition of this API is:

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:UpdateSparesStockRequest>

 

 

 

 

 

<NumLocs>?</NumLocs>

int

The value must be set to the number of <spareStock> structures in the request.

(tick)

 

 

<!-- Zero or more repetitions: -->

 

 

 

 

 

<spareStock>

 

 

(error)

 

 

 

<spareID>?</spareID>

SpareID

Identifier for the spare.

(tick)

(tick)

 

 

<LocType>?</LocType>

LocType

The location of the spare. Currently, only the Vehicle value is supported.

(tick)

 

 

 

<spareLoc>?</spareLoc>

EmpID

EmployeeID

(tick)

(tick)

 

 

<quantity>?</quantity>

int

The daily replenishment value which must be in the range 0-99.

(tick)

 

 

</spareStock>

 

 

 

 

</sp:UpdateSparesStockRequest>

 

 

 

 

Return Structure

The API returns the standard return structure.

Return Codes

In addition to the Integration ServiceOptimizer Common Standard Return Codes, the possible Integration ServiceOptimizer Common Return Codes from this API are:

  • SP_OK (0)
  • SP_EMPID_INVALID (5)
  • SP_INVALID_PARAM (35)
  • SP_INVALID_LOC_TYPE (78)
  • SP_QUANTITY_INVALID (112)

  • No labels