ElisyscdService

ElisyscdService.asmx

This web service provides methods related to system code values (database table SYCDVALU), including:

  • AddSystemCodeValue
  • ChangeSystemCodeValue
  • DeleteAddSystemCodeValue
  • ListSystemCodeValues

 

AddSystemCodeValue

This method adds one system code value.

Usage:

AddSystemCodeValueResult = A.AddSystemCodeValue(UserName, UserPassword, CodeType, CodeValue, CodeDescription, ExtraInput)

Parameters UserID and Password are not used at this moment.

 

Input Parameters

Parameter

Length

Type

Upper

Detail

CodeType

8

String

Y

Required. Code Type here must be an existing code type in table SYCDTYPE or you will get an error code.

CodeValue

15

String

Y

If you do not provide code value, it will default to blank.

CodeDescription

30

String

 

Code description.

ExtraInput

256

String

 

This parameter is not used at the moment.

* Upper = Y indicates the value of the property will be converted to upper case.

 

AddSystemCodeValueResult Structure

Property

Type

Detail

ReturnCode

Integer

Zero means OK. For other return codes, please refer to “Return Code” section.

ReturnMsg

String

This is the explaination of return code.

ExtraOutput

String

This property is not used at the moment.

 

Code Example (VB)

The following sample codes will add one system code value record for code type “TESTTYPE” and code value “TESTVALUE.”

 

Dim Service As New webServicesSyscd.ElisyscdService

Dim Result As New webServicesSyscd.AddSystemCodeValueResult

Result = Service.AddSystemCodeValue(Nothing, Nothing, “TESTTYPE”, “TESTVALUE”, “Test Description 1”, Nothing)

If Result.ReturnCode = 0 Then

  lblResult.Text = "System Code Value Record Created"

Else

  lblResult.Text = Result.ReturnMsg

  lblReturnCd.Text = Result.ReturnCode.ToString

End If

 

 

 

ChangeSystemCodeValue

This method changes one existing system code value’s code description.

Code type and Code value are key fields of this record. If you are changing either of these two key fields, you need to use DeleteSystemCodeValue first, and then use AddSystemCodeValue to create a new record.

 

Usage:

ChangeSystemCodeValueResult = A.ChangeSystemCodeValue(UserName, UserPassword, CodeType, CodeValue, CodeDescription, ExtraInput)

Parameters UserID and Password are not used at this moment.

 

Input Parameters

Parameter

Length

Type

Upper

Detail

CodeType

8

String

Y

Required. This is one of the key fields to locate the record to change.

CodeValue

15

String

Y

Required. This is one of the key fields to locate the record to change.

CodeDescription

30

String

 

Code description.

ExtraInput

256

String

 

This parameter is not used at the moment.

* Upper = Y indicates the value of the property will be converted to upper case.

 

ChangeSystemCodeValueResult Structure

Property

Type

Detail

ReturnCode

Integer

Zero means OK. For other return codes, please refer to “Return Code” section.

ReturnMsg

String

This is the explaination of return code.

ExtraOutput

String

This property is not used at the moment.

 

Code Example (VB)

The following sample codes will change the system code value record with code type “TESTTYPE” and code value “TESTVALUE.” It will change the code description to “Changed Description.”

 

Dim Service As New webServicesSyscd.ElisyscdService

Dim Result As New webServicesSyscd.ChangeSystemCodeValueResult

Result = Service.ChangeSystemCodeValue(Nothing, Nothing, “TESTTYPE”, “TESTVALUE”, “Changed Description”, Nothing)

If Result.ReturnCode = 0 Then

  lblResult.Text = "System Code Value Description Changed"

Else

  lblResult.Text = Result.ReturnMsg

  lblReturnCd.Text = Result.ReturnCode.ToString

End If

 

 DeleteSystemCodeValue

This method deletes one existing system code value.

 

Usage:

DeleteSystemCodeValueResult = A.DeleteSystemCodeValue(UserName, UserPassword, CodeType, CodeValue, CodeDescription, ExtraInput)

Parameters UserID and Password are not used at this moment.

 

Input Parameters

Parameter

Length

Type

Upper

Detail

CodeType

8

String

Y

Required. This is one of the key fields to locate the record to delete.

CodeValue

15

String

Y

Required. This is one of the key fields to locate the record to delete.

ExtraInput

256

String

 

This parameter is not used at the moment.

* Upper = Y indicates the value of the property will be converted to upper case.

 

DeleteSystemCodeValueResult Structure

Property

Type

Detail

ReturnCode

Integer

Zero means OK. For other return codes, please refer to “Return Code” section.

ReturnMsg

String

This is the explaination of return code.

ExtraOutput

String

This property is not used at the moment.

 

Code Example (VB)

The following sample codes will delete the system code value record with code type “TESTTYPE” and code value “TESTVALUE.”

 

Dim Service As New webServicesSyscd.ElisyscdService

Dim Result As New webServicesSyscd.DeleteSystemCodeValueResult

Result = Service.DeleteSystemCodeValue(Nothing, Nothing, “TESTTYPE”, “TESTVALUE”, Nothing)

If Result.ReturnCode = 0 Then

  lblResult.Text = "System Code Value Deleted"

Else

  lblResult.Text = Result.ReturnMsg

  lblReturnCd.Text = Result.ReturnCode.ToString

End If

 

 

ListSystemCodeValues

This method lists existing system code value using relational engine.

 Usage:                                           

ListSystemCodeValueResult = A.ListSystemCodeValue(UserName, UserPassword, CodeType, OrderBy, AdditionalWhereClause, ExtraInput)

Parameters UserID and Password are not used at this moment.

 

Input Parameters

Parameter

Length

Type

Detail

CodeType

8

String

Code Type to list. If you leave this field blank, this method will return all system code values.

OrderBy

15

String

This can be any field in SYCDVALU table. Which includes:

SYCDVALU_CD_TYPE

SYCDVALU_VALUE

SYCDVALU_DESC

AdditionalWhereClause

 

String

The value passed here will be appended to the WHERE clause with AND condition.

ExtraInput

256

String

This parameter is not used at the moment.

* Upper = Y indicates the value of the property will be converted to upper case.

 

ListSystemCodeValueResult Structure

Property

Type

Detail

ReturnCode

Integer

Zero means OK. For other return codes, please refer to “Return Code” section.

ReturnMsg

String

This is the explaination of return code.

SystemCodeValues

DataSet

This data set contains a data table “SystemCodeValues”, which contains the following data columns:

SYCDVALU_CD_TYPE

SYCDVALU_VALUE

SYCDVALU_DESC

SYCDVALU_FILLER1

SYCDVALU_FILLER2

ExtraOutput

String

This property is not used at the moment.

 

Code Example (VB)

The following sample codes will list system code value records for code type “TESTTYPE.”

 

Dim Service As New webServicesSyscd.ElisyscdService

Dim Result As New webServicesSyscd.ListSystemCodeValuesResult

Result = Service.ListSystemCodeValues(Nothing, Nothing, “TESTTYPE”, Nothing, Nothing, Nothing)

If Result.ReturnCode = 0 Then

  lblResult.Text = "The first code value is: " & _  Result.SystemCodeValues.Tables(0).Rows(0).Item("SYCDVALU_VALUE").ToString

Else

  lblResult.Text = Result.ReturnMsg

  lblReturnCd.Text = Result.ReturnCode.ToString

End If

 

ElisyscdService Return Code

0 = OK

1 = File Error

2 = Code Value Already On File (AddSystemCodeValue)

3 = Code Value Not On File or Locked By Other User (ChangeSystemCodeValue, DeleteSystemCodeValue)

4 = Code Type Not On File (AddSystemCodeValue)

5 = Code Type Required (AddSystemCodeValue, ChangeSystemCodeValue, DeleteSystemCodeValue)

30000 = Database Error (ListSystemCodeValue)

30001 = No record Found (ListSystemCodeValue)

30002 = General Error

CLS

 

Developer Documentations

  1. Received Code 9999 with Web Services Call
  2. Received Return Status Code 3 When Using Elilogin Login Method
  3. Elliott Web Service Requirements
  4. Elliott eStore Checklist
  5. LN API
  6. FN API
  7. RN API
  8. IN and DF API Change (V9.0)
  9. FA API Changes (V9.0)
  10. VA API Changes (V9.0)
  11. CartService
  12. EliarachService
  13. ElicshtxService
  14. EliattrbService
  15. ElisyscdService
  16. EliNoteService
  17. El2rstimService
  18. EliOrderService
  19. ItemInquiry
  20. EliitmiqService
  21. EliShiptoService
  22. El2getfrService
  23. Steps Required to Test ReportWriter in V8.2
  24. Installation of ElliottService, NETcellent’s Web Services for Elliott
  25. ResellerFinder
  26. EliaptrxService
  27. VendorInquiry
  28. EliloginService
  29. ElislsmnService
  30. EliserhsService
  31. EliatpobService
  32. ElievprcService
  33. ElihdtrxService
  34. ElicuswlService
  35. QueryTurnaround
  36. InvoiceInquiry
  37. ElicustmService
  38. EligetcdService
  39. OrderInquiry
  40. EliordiqService
  41. EliecontService
  42. EliautdpService
  43. El2CrCrdService
  44. Log-Timer / ElliottTimer.Ini Support
  45. Alpha Document Number Support (V8.5/V9.0)
  46. ElliottService System.TypeInitializationException
  47. Feature - Printing API to Dynamically Set Number of Copies
  48. The Values and Meanings of Distribution Types - ARDISFIL, APDISFIL, IMDISFIL, BMDISFIL
  49. DD API Changes (V9.0)
  50. PA API (8.5)
  51. Validate License API
  52. AP API
  53. TP API: Temporary Path
  54. Data Structures for Report Desk Defaults and Enforcements
  55. COBOL to VB Interface Programs
  56. IN API: Option to Support Files and Folders Validation
  57. FF API: File Functions
  58. ID API
  59. LK: Links API
  60. FFLNearYou
  61. Report Desk Developing and Debugging
  62. Developing a New Elliott V8.6 Report Desk User Defined Report (UDR)
  63. CustomerInquiry
  64. Elliott API (JSON Web Service)
  65. Animating COBOL Code in Elliott V8.5
  66. Preliminary Programming Changes for Elliott 8.6
  67. CV API
  68. System Lock File Requirements
  69. How to Write Test Codes for C# ESS Projects
  70. Solving the Inability to Debug Elliott on a New Server
  71. Report Desk: Developing Custom Reports
  72. Report Desk Tables
  73. Report Desk Database Delivery Strategy

Feedback and Knowledge Base