EligetcdService
EligetcdService.asmx
This web service is meant to return various code descriptions in Elliott.
CodeFinder
This method supports returning code descriptions of the following files: ARCODES, ARSLMFIL, IMLOCFIL, JOBFILE.
Usage:
CodeFinderResult = A.CodeFinder(UserName, UserPassword, FileName, KeyValue)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
|
Parameter |
Length |
Type |
Upper |
Detail |
|
FileName |
8 |
String |
Y |
Required. Can be one of the following values: "ARCODES": To find ship-via description, terms description, or tax code description. "ARSLMFIL": To find salesman name. "IMLOCFIL": To find location name. "JOBFILE": To find job name. |
|
KeyValue |
10 |
String |
Y |
Required. For “FileName” = “ARCODES,” the first digit is used to determine which type will be returned. If this field starts with “S,” ship-via description will be returned; if this field starts with “T,” terms code description will be returned; if this field starts with ‘X,’ system returns tax code description. For example, FileName= “ARCODES” and Keyvalue=“XAC” means to return description of tax code “AC.” |
CodeFinderResult Structure
|
Property Name |
Type |
Detail |
|
ReturnCode |
Integer |
0 = OK 1 = File Error 2 = File Name Not Provided 3 = Key Value Not Provided 4 = Invalid File Name 5 = Record Not On File |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
Description |
String |
Description of the input key. |
Code Example
The following sample code will return ship-via description of ship-via “01.”
Dim Service As New webServicesgetcd.EligetcdService
Dim Result As New webServicesgetcd.CodeFinderResult
Dim FileName As String = “ARCODES”
Dim KeyValue As String = “S01”
Result = Service.CodeFinder(“”, “”, FileName, KeyValue)
If Result.ReturnCode = 0 Then
lblResult.Text = “Description For Ship-via ‘01’: ” & _
Result.Description
Else
lblResult.Text = Result.ReturnMsg
lblErrorCode.Text = Result.ReturnCode.ToString
End If
CLS