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