EliattrbService

This web service provides methods to add, change, delete or list attributes in a file, the methods provided are:

  • AddAttribute
  • UpdateAttribute
  • DeleteAttribute
  • ListAttribute
  • ListOneAttributeCode
  • ListAllAttributeCode

 

AddAttribute

This method adds one attribute to the master file.

 Usage:

AddAttributeResult = A.AddAttribute(UserName, UserPassword, AddAttributeInput)

Parameters UserName and UserPassword are not used at this moment.

AddAttributeInput Structure

Many fields get their default value from the System Attribute Enhance file, where you can access it from Elliott System File Maintaince à Maintenance à Attribute Enhancement.

Property

Length

Type

Upper

Detail

ATTRIB_FILENAME

8

String

Y

Required (key field). File name such as “ARCUSFIL”, “IMITMFIL”

ATTRIB_REF_NUMBER

30

String

Y

Required (key field). Reference number such as “000001” for customer 000001 when ATTRIB_FILENAME = “ARCUSFIL”

ATTRIB_ATTRIBUTE

15

String

Y

Required (key field). This should be an existing attribute code.

ATTRIB_REFERENCE_1

30

String

 

If this field is empty, the system will get the default value from the   “System Attribute Enhance File.”

ATTRIB_REFERENCE_2

30

String

 

See ATTRIB_REFERENCE_1.

ATTRIB_REFERENCE_3

30

String

 

See ATTRIB_REFERENCE_1.

ATTRIB_REFERENCE_4

30

String

 

See ATTRIB_REFERENCE_1.

ATTRIB_REFERENCE_5

30

String

 

See ATTRIB_REFERENCE_1.

ATTRIB_DATE_1

8

Date

 

If this field is empty, the system will get the default date from the  "System Attribute Enhance File.”

ATTRIB_DATE_2

8

Date

 

See ATTRIB_DATE_1.

ATTRIB_DATE_3

8

Date

 

See ATTRIB_DATE_1.

ATTRIB_AMOUNT_1

8.4

Double

 

If this field is empty, the system will get the default amount from the “System Attribute Enhance File.”

ATTRIB_AMOUNT_2

8.4

Double

 

See ATTRIB_AMOUNT_1.

ATTRIB_AMOUNT_3

8.4

Double

 

See ATTRIB_AMOUNT_1.

ATTRIB_CHECK_BOX_1

1

String

Y

“Y”or “N.” If this field is empty, the system will get the default value from the “System Attribute Enhance File.”

ATTRIB_CHECK_BOX_2

1

String

Y

See ATTRIB_CHECK_BOX_1.

ATTRIB_CHECK_BOX_3

1

String

Y

See ATTRIB_CHECK_BOX_1.

ATTRIB_CREATED_BY

10

String

Y

Default to “SUPERVISOR.” We suggest that you pass a valid user id.

 

AddAttributeResult Structure

Property

Type

Detail

ReturnCode

Integer

Contains return code. Zero means OK; for other return codes, please see the “EliattrbService Return Code” section.

ReturnMsg

String

This is the description of the return code. For example, if the return code is zero, you can expect “OK” in this field.

 

Code Example

The following sample codes will add one attribute “CITIZEN” to customer “123456.”

 

Dim Service As New webServicesattrb.EliattrbService

Dim Result As New webServicesattrb.AddAttributeResult

Dim Input As New webServicesattrb.AddAttributeInput

Input.ATTRIB_FILENAME = “ARCUSFIL”

Input.ATTRIB_REF_NUMBER = “123456”

Input.ATTRIB_ATTRIBUTE = “CITIZEN”

Input.ATTRIB_AMOUNT_1= 35.24

Result = Service.AddAttribute(“”, “”, Input)

If Result.ReturnCode = 0 Then

   lblResult.Text = “Attribute Added”

Else

  lblResult.Text = “Error”

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

UpdateAttribute

This method updates field values of an attribute in a master file.

Usage:

UpdateAttributeResult = A.UpdateAttribute(UserName, UserPassword, UpdateAttributeInput)

Parameters UserName and UserPassword are not used at this moment.

 

UpdateAttributeInput Structure

Property

Length

Type

Upper

Detail

ATTRIB_FILENAME

8

String

Y

Required (key field). This field is used to locate the attribute to change.

ATTRIB_REF_NUMBER

30

String

Y

Required (key field). This field is used to locate the attribute to change.

ATTRIB_ATTRIBUTE

15

String

Y

Required (key field). This field is used to locate the attribute to change.

ATTRIB_REFERENCE_1

30

String

 

Reference 1.

ATTRIB_REFERENCE_2

30

String

 

Reference 2.

ATTRIB_REFERENCE_3

30

String

 

Reference 3.

ATTRIB_REFERENCE_4

30

String

 

Reference 4.

ATTRIB_REFERENCE_5

30

String

 

Reference 5.

ATTRIB_DATE_1

 

Date

 

Date 1.

ATTRIB_DATE_2

 

Date

 

Date 2.

ATTRIB_DATE_3

 

Date

 

Date 3.

ATTRIB_AMOUNT_1

8.4

Double

 

Amount 1.

ATTRIB_AMOUNT_2

8.4

Double

 

Amount 2.

ATTRIB_AMOUNT_3

8.4

Double

 

Amount 3.

ATTRIB_CHECK_BOX_1

1

String

Y

Check box 1. “Y”, “N.”

ATTRIB_CHECK_BOX_2

1

String

Y

Check box 2. “Y”, “N.”

ATTRIB_CHECK_BOX_3

1

String

Y

Check box 3. “Y”, “N.”

ATTRIB_MODIFY_BY

10

String

Y

Modify by. We suggest that you pass a valid user id.

 

UpdateAttributeResult 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 the description of the return code. For example, if the   return code is zero, you can expect “OK” in this field.

 

Code Example

The following sample codes will update “amount 1” and “amount 2” of an attribute.

 

Dim Service As New webServicesattrb.EliattrbService

Dim Result As New webServicesattrb.UpdateAttributeResult

Dim Input As New webServicesattrb.UpdateAttributeInput

Input.ATTRIB_FILENAME = “ARCUSFIL”

Input.ATTRIB_REF_NUMBER = “123456”

Input.ATTRIB_ATTRIBUTE = “CITIZEN”

Input.ATTRIB_AMOUNT_1= 12.6

Input.ATTRIB_AMOUNT_2= 55.45

Result = Service.UpdateAttribute(“”, “”, Input)

If Result.ReturnCode = 0 Then

   lblResult.Text = “Attribute Updated”

Else

  lblResult.Text = “Error”

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

DeleteAttribute

This method deletes one attritube from a master file.

Usage:

DeleteAttributeResult = A.DeleteAttribute(UserName, UserPassword, DeleteAttributeInput)

Parameters UserName and UserPassword are not used at this moment.

 

DeleteAttributeInput Structure

Property

Length

Type

Upper

Detail

ATTRIB_FILENAME

8

String

Y

Required (key field).

ATTRIB_REF_NUMBER

30

String

Y

Required (key field).

ATTRIB_ATTRIBUTE

15

String

Y

Required (key field).

 

DeleteAttributeResult 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 the description of the return code. For example, if the return code is zero, you can expect “OK” in this field.

 

Code Example

The following sample codes will delete “CITIZEN” attribute from customer “123456.”

 

Dim Service As New webServicesattrb.EliattrbService

Dim Result As New webServicesattrb.DeleteAttributeResult

Dim Input As New webServicesattrb.DeleteAttributeInput

Input.ATTRIB_FILENAME = “ARCUSFIL”

Input.ATTRIB_REF_NUMBER = “123456”

Input.ATTRIB_ATTRIBUTE = “CITIZEN”

Result = Service.DeleteAttribute(“”, “”, Input)

If Result.ReturnCode = 0 Then

   lblResult.Text = “Attribute Deleted”

Else

  lblResult.Text = “Error”

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

ListAttribute

This method will list one or more attributes in the master file. The maximum returned attributes is limited to 100 records.

Usage:

ListAttributeResult = A.ListAttribute(UserName, UserPassword, ListAttributeInput)

Parameters UserName and UserPassword are not used at this moment.

 

ListAttributeInput Structure

Property

Length

Type

Upper

Detail

ATTRIB_FILENAME

8

String

Y

Required (key field).

ATTRIB_REF_NUMBER

30

String

Y

Required (key field).

ATTRIB_ATTRIBUTE

15

String

Y

If this field has value, this method lists one attribute that matchs input file name, reference number and attribute id.

If this field is blank, this method lists all attributes that match input file name and reference number.

NextAttribute

15

String

Y

This field only works when input ATTRIB_ATTRIBUTE is blank.

In this scenario, there may be more than 100 records in the master file, but our maximum returned records is 100. If there are more than 100 records to return, you will find that NextAttribute in output structure has a value, and you can call ListAttribute again and pass the output’s NextAttribute as input’s NextAttribute, so that you can get the 101th – 200th attributes attached to the master file.

 

ListAttributeResult 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 the description of the return code. For example, if the return code is zero, you can expect “OK” in this field.

AttributeRecord()

AttributeRecord

Maximum return 100 records.

EOFFlag

String

If attributes listed reach the end of the file, this flag will be “Y.”

NextAttribute

String

Next attribute.

 

AttributeRecord Structure

Property

Type

Detail

ATTR_FILENAME

String

Attribute master file name such as “ARCUSFIL,” which indicates this attribute is for a customer.

ATTR_REF_NUMBER

String

Attribute master file number such as “000001,” which indicates customer# 000001 when ATTR_FILENAME is “ARCUSFIL.”

ATTR_ATTRIBUTE

String

Attribute id.

ATTR_REFERENCE_1

String

Reference 1.

ATTR_REFERENCE_2

String

Reference 2.

ATTR_REFERENCE_3

String

Reference 3.

ATTR_REFERENCE_4

String

Reference 4.

ATTR_REFERENCE_5

String

Reference 5.

ATTR_DATE_1

Date

Date 1.

ATTR_DATE_2

Date

Date 2.

ATTR_DATE_3

Date

Date 3.

ATTR_AMOUNT_1

Double

Amount 1.

ATTR_AMOUNT_2

Double

Amount 2.

ATTR_AMOUNT_3

Double

Amount 3.

ATTR_CHECK_BOX_1

String

Check box 1.

ATTR_CHECK_BOX_2

String

Check box 2.

ATTR_CHECK_BOX_3

String

Check box 3.

ATTR_CREATE_DATE

Date

Create date.

ATTR_CREATE_TIME

Integer

Create time.

ATTR_CREATE_BY

String

Create by user id.

ATTR_MODIFY_DATE

Date

Modify date.

ATTR_MODIFY_TIME

Integer

Modify time.

ATTR_MODIFY_BY

String

Modify by user id.

ATTR_MODIFY_COUNTER

Integer

This indicates how many times this attribute has been modified. When this attribute is created, this field starts with zero.

ATTR_FILLER

String

Normally this field is empty.

ATTR_DESC_1

String

Description 1 of attribute id.

ATTR_DESC_2

String

Description 2 of attribute id.

ATTR_REFERENCE_FLAG_1

String

“E”: This reference field is enabled.

“B”: This reference field is disabled.

Blank: This reference field is deleted.

ATTR_REFERENCE_FLAG_2

String

See ATTR_REFERENCE_FLAG_1.

ATTR_REFERENCE_FLAG_3

String

See ATTR_REFERENCE_FLAG_1.

ATTR_REFERENCE_FLAG_4

String

See ATTR_REFERENCE_FLAG_1.

ATTR_REFERENCE_FLAG_5

String

See ATTR_REFERENCE_FLAG_1.

ATTR_REFERENCE_LIT_1

String

Literal of Reference 1.

ATTR_REFERENCE_LIT_2

String

Literal of Reference 2.

ATTR_REFERENCE_LIT_3

String

Literal of Reference 3.

ATTR_REFERENCE_LIT_4

String

Literal of Reference 4.

ATTR_REFERENCE_LIT_5

String

Literal of Reference 5.

ATTR_DATE_FLAG_1

String

“E”: This date field is enabled.

“B”: This date field is disabled.

Blank: This date field is deleted.

ATTR_DATE_FLAG_2

String

See ATTR_DATE_FLAG_1.

ATTR_DATE_FLAG_3

String

See ATTR_DATE_FLAG_1.

ATTR_DATE_LIT_1

String

Literal of Date 1.

ATTR_DATE_LIT_2

String

Literal of Date 2.

ATTR_DATE_LIT_3

String

Literal of Date 3.

ATTR_AMOUNT_FLAG_1

String

“E”: This amount field is enabled.

“B”: This amount field is disabled.

Blank: This amount field is deleted.

ATTR_AMOUNT_FLAG_2

String

See ATTR_AMOUNT_FLAG _1.

ATTR_AMOUNT_FLAG_3

String

See ATTR_AMOUNT_FLAG _1.

ATTR_AMOUNT_LIT_1

String

Literal of Amount 1.

ATTR_AMOUNT_LIT_2

String

Literal of Amount 2.

ATTR_AMOUNT_LIT_3

String

Literal of Amount 3.

ATTR_CHECK_BOX_FLAG_1

String

“E”: This check box is enabled.

“B”: This check box is disabled.

Blank: This check box is deleted.

ATTR_CHECK_BOX_FLAG_2

String

See ATTR_CHECK_BOX_FLAG _1.

ATTR_CHECK_BOX_FLAG_3

String

See ATTR_CHECK_BOX_FLAG _1.

ATTR_CHECK_BOX_LIT_1

String

Literal of check box 1.

ATTR_CHECK_BOX_LIT_2

String

Literal of check box 2.

ATTR_CHECK_BOX_LIT_3

String

Literal of check box 3.

ATTR_ORDER_OH_FLAG_1

String

“S”: Stop order entry when past the date.

“H”: Put order on hold when past the date.

ATTR_ORDER_OH_FLAG_2

String

See ATTR_ORDER_OH_FLAG_1.

ATTR_ORDER_OH_FLAG_3

String

See ATTR_ORDER_OH_FLAG_1.

ATTR_GRACE_PERIOD_1

Integer

Grace period of date 1.

ATTR_GRACE_PERIOD_2

Integer

Grace period of date 2.

ATTR_GRACE_PERIOD_3

Integer

Grace period of date 3.

ATTR_PRIMARY_FIELD_1

String

Can be “R1”, “R2”, “R3”, “R4”, “R5”, “D1”, which R1 refers to “Reference 1” and D1 refers to “Date 1” field.

ATTR_PRIMARY_FIELD_2

String

See ATTR_PRIMARY_FIELD_1.

ATTR_WEB_ATTRIBUTE

String

“Y” or “N.”

ATTR_ENH_REF_FLD_LEN_1

Integer

Maximum length of reference field 1.

ATTR_ENH_REF_DEF_VALUE_1

String

Default value of reference field 1.

ATTR_ENH_REF_FLD_TYPE_1

String

F=Free Form, V=Predefined Value, M=Master Table, Q=Question

ATTR_ENH_REF_MAST_TBL_1

String

Master table or code type associated with the field type for reference field 1.

ATTR_ENH_REF_ALLOW_BLANK_1

String

Specifies if blanks are allowed for reference field 1.

ATTR_ENH_REF_VALUE_1

String

If the field type is V, this is the full description of the code type value that was chosen for reference field 1. Otherwise, this field is blank.

ATTR_ENH_REF_FLD_LEN_2

Integer

Maximum length of reference field 2.

ATTR_ENH_REF_DEF_VALUE_2

String

Default value of reference field 2.

ATTR_ENH_REF_FLD_TYPE_2

String

F=Free Form, V=Predefined Value, M=Master Table, Q=Question

ATTR_ENH_REF_MAST_TBL_2

String

Master table or code type associated with the field type for reference field 2.

ATTR_ENH_REF_ALLOW_BLANK_2

String

Specifies if blanks are allowed for reference field 2.

ATTR_ENH_REF_VALUE_2

String

If the field type is V, this is the full description of the code type value that was chosen for reference field 2. Otherwise, this field is blank.

ATTR_ENH_REF_FLD_LEN_3

Integer

Maximum length of reference field 3.

ATTR_ENH_REF_DEF_VALUE_3

String

Default value of reference field 3.

ATTR_ENH_REF_FLD_TYPE_3

String

F=Free Form, V=Predefined Value, M=Master Table, Q=Question

ATTR_ENH_REF_MAST_TBL_3

String

Master table or code type associated with the field type for reference field 3.

ATTR_ENH_REF_ALLOW_BLANK_3

String

Specifies if blanks are allowed for reference field 3.

ATTR_ENH_REF_VALUE_3

String

If the field type is V, this is the full description of the code type value that was chosen for reference field 3. Otherwise, this field is blank.

ATTR_ENH_REF_FLD_LEN_4

Integer

Maximum length of reference field 4.

ATTR_ENH_REF_DEF_VALUE_4

String

Default value of reference field 4.

ATTR_ENH_REF_FLD_TYPE_4

String

F=Free Form, V=Predefined Value, M=Master Table, Q=Question

ATTR_ENH_REF_MAST_TBL_4

String

Master table or code type associated with the field type for reference field 4.

ATTR_ENH_REF_ALLOW_BLANK_4

String

Specifies if blanks are allowed for reference field 4.

ATTR_ENH_REF_VALUE_4

String

If the field type is V, this is the full description of the code type value that was chosen for reference field 4. Otherwise, this field is blank.

ATTR_ENH_REF_FLD_LEN_5

Integer

Maximum length of reference field 5.

ATTR_ENH_REF_DEF_VALUE_5

String

Default value of reference field 4.

ATTR_ENH_REF_FLD_TYPE_5

String

F=Free Form, V=Predefined Value, M=Master Table, Q=Question

ATTR_ENH_REF_MAST_TBL_5

String

Master table or code type associated with the field type for reference field 5.

ATTR_ENH_REF_ALLOW_BLANK_5

String

Specifies if blanks are allowed for reference field 5.

ATTR_ENH_REF_VALUE_5

String

If the field type is V, this is the full description of the code type value that was chosen for reference field 5. Otherwise, this field is blank.

ATTR_ENH_AMT_NO_DIGIT_1

Integer

Number of digits in amount field 1.

ATTR_ENH_AMT_NO_DEC_1

Integer

Number of decimals in amount field 1.

ATTR_ENH_AMT_MIN_VALUE_1

Double

Minimum value for amount field 1.

ATTR_ENH_AMT_MAX_VALUE_1

Double

Maximum value for amount field 1.

ATTR_ENH_AMT_DEF_VALUE_1

Double

Default value for amount field 1.

ATTR_ENH_AMT_NO_DIGIT_2

Integer

Number of digits in amount field 2.

ATTR_ENH_AMT_NO_DEC_2

Integer

Number of decimals in amount field 2.

ATTR_ENH_AMT_MIN_VALUE_2

Double

Minimum value for amount field 2.

ATTR_ENH_AMT_MAX_VALUE_2

Double

Maximum value for amount field 2.

ATTR_ENH_AMT_DEF_VALUE_2

Double

Default value for amount field 2.

ATTR_ENH_AMT_NO_DIGIT_3

Integer

Number of digits in amount field 3.

ATTR_ENH_AMT_NO_DEC_3

Integer

Number of decimals in amount field 3.

ATTR_ENH_AMT_MIN_VALUE_3

Double

Minimum value for amount field 3.

ATTR_ENH_AMT_MAX_VALUE_3

Double

Maximum value for amount field 3.

ATTR_ENH_AMT_DEF_VALUE_3

Double

Default value for amount field 3.

ATTR_ENH_DATE_DEF_SETTING_1

String

N=None, S=System Date, +/-=Adjust, D=Specific Date

ATTR_ENH_DATE_ADJUST_VALUE_1

Integer

If default setting is set to +/-, value to use to adjust date field 1.

ATTR_ENH_DATE_CERTAIN_DATE_1

Date

If default setting is set to D, this is the specific date for date field 1.

ATTR_ENH_DATE_DEF_SETTING_2

String

N=None, S=System Date, +/-=Adjust, D=Specific Date

ATTR_ENH_DATE_ADJUST_VALUE_2

Integer

If default setting is set to +/-, value to use to adjust date field 2.

ATTR_ENH_DATE_CERTAIN_DATE_2

Date

If default setting is set to D, this is the specific date for date field 2.

ATTR_ENH_DATE_DEF_SETTING_3

String

N=None, S=System Date, +/-=Adjust, D=Specific Date

ATTR_ENH_DATE_ADJUST_VALUE_3

Integer

If default setting is set to +/-, value to use to adjust date field 3.

ATTR_ENH_DATE_CERTAIN_DATE_3

Date

If default setting is set to D, this is the specific date for date field 3.

ATTR_ENH_CKB_DEF_CHECK_BOX_1

String

Default value for check box 1.

ATTR_ENH_CKB_DEF_CHECK_BOX_2

String

Default value for check box 2.

ATTR_ENH_CKB_DEF_CHECK_BOX_3

String

Default value for check box 3.

  

Code Example

If you call ListAttribute method the first time and the output “NextAttribute” has a value, you know there are more attributes that can be returned. In this case, you can call ListAttribute method again with input “NextAttribute” to get the rest of the attributes.

The following sample codes assumes you get a “NextAttribute” = “CITIZEN” from last call.  Now you want to list attributes for customer# 123456 starting from the first attribute “CITIZEN”:

 

Dim Service As New webServicesattrb.EliattrbService

Dim Result As New webServicesattrb.ListAttributeResult

Dim Input As New webServicesattrb.ListAttributeInput

Input.ATTRIB_FILENAME = “ARCUSFIL”

Input.ATTRIB_REF_NUMBER = “123456”

Input.NextAttribute = “CITIZEN”

Result = Service.ListAttribute(“”, “”, Input)

If Result.ReturnCode = 0 Then

  If Result.AttributeRecord.Count > 0 Then

     lblResult.Text = “First Matching Attribute: ” & _

                      Result.AttributeRecord(0).ATTR_ATTRIBUTE

  Else

     lblResult.Text = “No Matching Attribute.”     

  End If

Else

  lblResult.Text = “Error”

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

ListOneAttributeCode

This method will return one attribute code from table SYATRFIL.

Usage:

ListOneAttributeCodeResult = A.ListOneAttributeCode(UserName, UserPassword, ListOneAttributeCodeInput)

Parameters UserName and UserPassword are not used at this moment.

 

ListOneAttributeCodeInput Structure

Property

Length

Type

Upper

Detail

SYATRFIL_ATTRIBUTE

15

String

Y

Required.

 

ListOneAttributeCodeResult 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.

AttributeCodeRecord

AttributeRecord

See the following section for its structure.

 

AttributeRecord Structure

Property

Type

Detail

SYATRFIL_ATTRIBUTE

String

Attribute id.

SYATRFIL_DESC_1

String

Description 1 of attribute id.

SYATRFIL_DESC_2

String

Description 2 of attribute id.

SYATRFIL_REFERENCE_FLAG_1

String

“E”: This reference field is enabled.

“B”: This reference field is disabled.

Blank: This reference field is deleted.

SYATRFIL_REFERENCE_FLAG_2

String

See ATTR_REFERENCE_FLAG_1.

SYATRFIL_REFERENCE_FLAG_3

String

See ATTR_REFERENCE_FLAG_1.

SYATRFIL_REFERENCE_FLAG_4

String

See ATTR_REFERENCE_FLAG_1.

SYATRFIL_REFERENCE_FLAG_5

String

See ATTR_REFERENCE_FLAG_1.

SYATRFIL_REFERENCE_LIT_1

String

Literal of Reference 1.

SYATRFIL_REFERENCE_LIT_2

String

Literal of Reference 2.

SYATRFIL_REFERENCE_LIT_3

String

Literal of Reference 3.

SYATRFIL_REFERENCE_LIT_4

String

Literal of Reference 4.

SYATRFIL_REFERENCE_LIT_5

String

Literal of Reference 5.

SYATRFIL_DATE_FLAG_1

String

“E”: This date field is enabled.

“B”: This date field is disabled.

Blank: This date field is deleted.

SYATRFIL_DATE_FLAG_2

String

See ATTR_DATE_FLAG_1.

SYATRFIL_DATE_FLAG_3

String

See ATTR_DATE_FLAG_1.

SYATRFIL_DATE_LIT_1

String

Literal of Date 1.

SYATRFIL_DATE_LIT_2

String

Literal of Date 2.

SYATRFIL_DATE_LIT_3

String

Literal of Date 3.

SYATRFIL_AMOUNT_FLAG_1

String

“E”: This amount field is enabled.

“B”: This amount field is disabled.

Blank: This amount field is deleted.

SYATRFIL_AMOUNT_FLAG_2

String

See ATTR_AMOUNT_FLAG _1.

SYATRFIL_AMOUNT_FLAG_3

String

See ATTR_AMOUNT_FLAG _1.

SYATRFIL_AMOUNT_LIT_1

String

Literal of Amount 1.

SYATRFIL_AMOUNT_LIT_2

String

Literal of Amount 2.

SYATRFIL_AMOUNT_LIT_3

String

Literal of Amount 3.

SYATRFIL_CHECK_BOX_FLAG_1

String

“E”: This check box is enabled.

“B”: This check box is disabled.

Blank: This check box is deleted.

SYATRFIL_CHECK_BOX_FLAG_2

String

See ATTR_CHECK_BOX_FLAG _1.

SYATRFIL_CHECK_BOX_FLAG_3

String

See ATTR_CHECK_BOX_FLAG _1.

SYATRFIL_CHECK_BOX_LIT_1

String

Literal of check box 1.

SYATRFIL_CHECK_BOX_LIT_2

String

Literal of check box 2.

SYATRFIL_CHECK_BOX_LIT_3

String

Literal of check box 3.

SYATRFIL_ORDER_OH_FLAG_1

String

“S”: Stop order entry when past the date.

“H”: Put order on hold when past the date.

SYATRFIL_ORDER_OH_FLAG_2

String

See ATTR_ORDER_OH_FLAG_1.

SYATRFIL_ORDER_OH_FLAG_3

String

See ATTR_ORDER_OH_FLAG_1.

SYATRFIL_GRACE_PERIOD_1

Integer

Grace period of date 1.

SYATRFIL_GRACE_PERIOD_2

Integer

Grace period of date 2.

SYATRFIL_GRACE_PERIOD_3

Integer

Grace period of date 3.

SYATRFIL_PRIMARY_FIELD_1

String

Can be “R1”, “R2”, “R3”, “R4”, “R5”, “D1”, which R1 refers to “Reference 1”, and D1 refers to “Date 1” field.

SYATRFIL_PRIMARY_FIELD_2

String

See ATTR_PRIMARY_FIELD_1.

SYATRFIL_WEB_ATTRIBUTE

String

“Y” or “N”.

 

Code Example

The following sample codes will return properities of attribute code “CITIZEN.”

 

Dim Service As New webServicesattrb.EliattrbService

Dim Result As New webServicesattrb.ListOneAttributeCodeResult

Dim Input As New webServicesattrb.ListOneAttributeCodeInput

Input.SYATRFIL_ATTRIBUTE = “CITIZEN”

Result = Service.ListOneAttributeCode(“”, “”, Input)

If Result.ReturnCode = 0 Then

  If Result.AttributeCodeRecord.SYATRFIL_ATTRIBUTE <> Nothing Then

     lblResult.Text = “Attribute Desc: ” & _

                      Result.AttributeCodeRecord.SYATRFIL_DESC_1

  Else

     lblResult.Text = “No Matching Attribute.”     

  End If

Else

  lblResult.Text = “Error”

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

ListAllAttributeCode

This method will return all attribute codes from table SYATRFIL.

Usage:

ListAllAttributeCodeResult = A.ListAllAttributeCode(UserID, Password)

Parameters UserName and UserPassword are not used at this moment.

 

ListAllAttributeCodeResult 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 the description of the return code. For example, if the  return code is zero, you can expect “OK” in this field.

AttributeCode()

AttributeRecord

Maximum return 500 records. For the structure of AttributeRecord type, refer to “AttributeRecord Structure” in ListOneAttributeCode method.

 

Code Example

The following sample codes will list all attribute codes.

 

Dim Service As New webServicesattrb.EliattrbService

Dim Result As New webServicesattrb.ListAllAttributeCodeResult

Result = Service.ListAllAttributeCode(“”, “”)

If Result.ReturnCode = 0 Then

  If Result.AttributeCode.Length > 0 Then

     lblResult.Text = “First Attribute Desc: ” & _

                      Result.AttributeCode(0).SYATRFIL_DESC_1

  Else

     lblResult.Text = “No Matching Attribute.”     

  End If

Else

  lblResult.Text = “Error”

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

EliattrbService Return Code

 0 = OK

 1 = File Error

 2 = Data Missing (File Name, Reference ID, Attribute Code)

 3 = Attribute Already Exists in File (Add)

 4 = Attribute Does Not Exist in File (Change/Delete)

 5 = Required Field For Attribute Not Provided

 6 = Field For Attribute Not Allowed

 7 = Attribute Code Does Not Exist in SYATRFIL

 8 = Attribute Code Not Provided (Get One Attribute Code)

 9 = Detail File / Ref No. Not Found (Add Attribute)

10 = This Attribute is Only For Master File

11 = Error from SYSAECHK

12 = ChkBox-1/2/3 must be Y, N or blank.

CLS

Feedback and Knowledge Base