ElihdtrxService
ElihdtrxService.asmx
This web service provides methods to manipulate hold transaction file IMHLTFIL, including:
- HoldInventory
- CancelInventory
- ExtInventory
- ViewInventory
This service corresponds to Elliott “Hold Transaction File Maintenance.”
HoldInventory
This method creates one hold transaction record.
Usage:
HoldInventoryResult = A.HoldInventory(UserName, UserPassword, itemNo, location, serialNo, userID, quantity, description, emailAddress, noOfDays)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
|
Parameter |
Length |
Type |
Upper |
Detail |
|
itemNo |
15 |
String |
Y |
Required. Item number to hold. |
|
location |
2 |
String |
Y |
Required. Item location. |
|
serialNo |
15 |
String |
Y |
Serial/lot number. |
|
userID |
10 |
String |
Y |
Required. |
|
quantity |
9.3 |
Double |
|
If you do not pass a value, this field will be zero. |
|
description |
30 |
String |
|
Description. |
|
emailAddress |
60 |
String |
|
Email address. |
|
noOfDays |
3 |
Integer |
|
Number of days to keep holding this item. |
HoldInventoryResult Structure
|
Property |
Type |
Detail |
|
ReturnCode |
Integer |
Contains return code. Zero means OK; for other return codes, please see “EliattrbService Return Code” section. |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
TrxID |
Integer |
Hold Transaction ID of the hold inventory just created. |
Code Example
The following sample code will create one hold inventory transaction record for item “049.”
Dim Service As New webServiceshdtrx.ElihdtrxService
Dim Result As New webServiceshdtrx.HoldInventoryResult
Dim itemNo As String = “049”
Dim location As String = “P”
Dim userID As String = “ABC”
Dim quantity As Integer = 10
Dim noOfDays As Integer = 15
Result = Service.HoldInventory(“”, “”, itemNo, location, “”, userID, quantity, “”, “”, noOfDays)
If Result.ReturnCode = 0 Then
lblResult.Text = “Hold Transaction Added, ID:” & _
Result.TrxID
Else
lblResult.Text = Result.ReturnMsg
lblErrorCode.Text = Result.ReturnCode.ToString
End If
This method cancels one hold transaction record.
Usage:
CancelInventoryResult = A.CancelInventory(UserName, UserPassword, trxID)
Parameters UserName and UserPassword are not used at this moment.
CancelInventoryInput Parameters
|
Parameter |
Length |
Type |
Upper |
Detail |
|
trxID |
9 |
Integer |
|
Required. |
Output Parameter
|
Property |
Type |
Detail |
|
CancelInventoryResult |
Integer |
Contains return code. Zero means OK; for other return codes, please see “EliattrbService Return Code” section. |
Code Example
The following sample code will cancel (delete) one hold inventory transaction.
Dim Service As New webServiceshdtrx.ElihdtrxService
Dim Result As Integer
Dim TrxID As Integer = 877845217
Result = Service.CancelInventory(“”, “”, TrxID)
If Result = 0 Then
lblResult.Text = “Hold Transaction Canceled.”
Else
lblResult.Text = “Error”
lblErrorCode.Text = Result.ToString
End If
This method extends one hold transaction’s expiration day.
Usage:
ExtInventoryResult = A.ExtInventory(UserName, UserPassword, trxID, noOfDays)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
|
Parameter |
Length |
Type |
Upper |
Detail |
|
trxID |
9 |
Integer |
|
Required. |
|
noOfDays |
3 |
Integer |
|
Required. Must be greater than zero. New expiration date will be set to number of days from system date. |
Output Parameter
|
Property |
Type |
Detail |
|
ExtInventoryResult |
Integer |
Contains return code. Zero means OK; for other return codes, please see “EliattrbService Return Code” section. |
Code Example
The following sample code will extend one hold inventory transaction for 12 days.
Dim Service As New webServiceshdtrx.ElihdtrxService
Dim Result As Integer
Dim TrxID As Integer = 877845217
Dim noOfDays As Integer = 12
Result = Service.ExtInventory(“”, “”, TrxID, noOfDays)
If Result = 0 Then
lblResult.Text = “Hold Transaction Extended.”
Else
lblResult.Text = “Error”
lblErrorCode.Text = Result.ToString
End If
This method returns one hold inventory transaction record.
Usage:
ViewInventoryResult = A.ViewInventory(UserName, UserPassword, trxID)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
|
Parameter |
Length |
Type |
Upper |
Detail |
|
trxID |
9 |
Integer |
|
Required. |
ViewInventoryResult Structure
|
Property |
Type |
Detail |
|
ReturnCode |
Integer |
Contains return code. Zero means OK; for other return codes, please see “EliattrbService Return Code” section. |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
ItemNo |
String |
|
|
Location |
String |
|
|
SerialNo |
String |
|
|
UserID |
String |
|
|
Quantity |
Double |
|
|
Description |
String |
|
|
EmailAddress |
String |
|
Code Example
The following sample code will get the information of hold transaction id “877845217.”
Dim Service As New webServiceshdtrx.ElihdtrxService
Dim Result As New webServiceshdtrx.ViewInventoryResult
Dim TrxID As Integer = 877845217
Result = Service.ViewInventory(“”, “”, TrxID)
If Result.ReturnCode = 0 Then
lblResult.Text = “Hold Transaction Item No:” & Result.ItemNo & _
“ Location:” & Result.Location
Else
lblResult.Text = “Error”
lblErrorCode.Text = Result.ReturnCode.ToString
End If
0 = OK (Hold & Cancel & Extend)
1 = File Error (Hold & Cancel & Extend)
2 = Data Missing (Item No, Location, User ID) (Hold)
3 = Item Not On File (Hold)
4 = Inventory Location Not Found (Hold)
5 = No Trx ID (Cancel & Extend)
6 = No Hold Trx (Cancel)
8 = Non-Serialized Item Serial Number Must Be Blank
9 = No Serial Number For Serialized Item
10 = No Extend No of Days (Extend)
CLS