You are viewing an old version of this content. View the current version.
Compare with Current
View Version History
« Previous
Version 55
Next »
On This Page:
Related Pages:
The sp:UpdateSparesStockRequest
API method can be used to update the quantity of spares held in an employee's vehicle.
Description
The sp:UpdateSparesStockRequest
API method updates the quantities of spares 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. | 
| |
| <!-- Zero or more repetitions: -->
|
| | | |
| <spareStock>
|
| | 
| |
| | <spareID>?</spareID>
| SpareID
| Identifier for the spare. | 
| 
|
| | <LocType>?</LocType>
| LocType
| The location of the spare. Currently, only the Vehicle value is supported. | 
| |
| | <spareLoc>?</spareLoc>
| EmpID
| EmployeeID | 
| 
|
| | <quantity>?</quantity>
| int
| The daily replenishment value which must be in the range 0-99. | 
| |
| </spareStock>
|
| | | |
</sp:UpdateSparesStockRequest>
|
| | | |
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible 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)