ElicuswlService

ElicuswlService.asmx

This web service provides methods to add, change delete, and view customer wish lists.

 

AddWishList

This method adds a customer wish list record. The key fields of a wish list record are customer number, ship-to number, contact id, product category, item number, and sequence number. Before adding a record, you should use ViewCustomerWishList method to confirm that there is no duplication.

Usage:

AddWishListResult = A.AddWishList(UserName, UserPassword, AddWishListInput)

Parameters UserName and UserPassword are not used at this moment.

 

AddWishListInput Structure

Parameter

Length

Type

Upper

Detail

WISHLIST_CUST_NO

6

String

Y

Required. System will automatically pad zeros to the customer number.

WISHLIST_SHIPTO_NO

4

String

Y

Ship-To number.

WISHLIST_CONTACTID

9

Integer

 

Contact ID.

WISHLIST_PROD_CAT

3

String

Y

Product category.

WISHLIST_ITEM_NO

15

String

Y

Required. Item number.

WISHLIST_SEQ_NO

4

Integer

 

Sequence number.

WISHLIST_EVT_ACT_ID

9

Integer

 

Event action id.

WISHLIST_CREATE_DT

 

Date

 

Create date. Default to system date.

WISHLIST_LST_REQ_DT

 

Date

 

Last require date. Default to system date.

WISHLIST_EXP_DT

 

Date

 

Expiration date. Default to “Last require date” + “Expire in days.”

WISHLIST_REQ_QTY

9.3

Double

 

Requested quantity. Default to 1.

WISHLIST_REF

30

String

 

Reference

WISHLIST_EMAIL

45

String

 

Email address.

WISHLIST_EXP_DAYS

3

Integer

 

Expire in days. Default to 365.

WISHLIST_LOCATION

2

String

Y

Location. Default to item’s default location.

 

Output Parameters

Parameter

Type

Detail

AddWishListResult

Integer

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

 

Code Example

The following sample code will add one wish list for customer “000456” and item number “049.”

 

Dim Service As New webServicescuswl.ElicuswlService

Dim Result As Integer

Dim Input As New webServicescuswl.AddWishListInput

Input.WISHLIST_CUST_NO = “000456”

Input.WISHLIST_ITEM_NO = “049”

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

If Result = 0 Then

   lblResult.Text = “WishList Added.”

Else

  lblResult.Text = “Error”

  lblErrorCode.Text = Result.ReturnCode.ToString

End If

 

ChangeWishList

This method will change a customer wish list record by providing key fields.

Usage:

ChangeWishListResult = A.ChangeWishList(UserName, UserPassword, ChangeWishListInput)

Parameters UserName and UserPassword are not used at this moment.

 

ChangeWishListInput Structure

Property

Length

Type

Upper

Detail

WISHLIST_CUST_NO

6

String

Y

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

WISHLIST_SHIPTO_NO

4

String

Y

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

WISHLIST_CONTACTID

9

Integer

 

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

WISHLIST_PROD_CAT

3

String

Y

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

WISHLIST_ITEM_NO

15

String

Y

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

WISHLIST_SEQ_NO

4

Integer

 

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

WISHLIST_EVT_ACT_ID

9

Integer

 

Event action id.

WISHLIST_CREATE_DT

 

Date

 

Create date.

WISHLIST_LST_REQ_DT

 

Date

 

Last require date.

WISHLIST_EXP_DT

 

Date

 

Expiration date.

WISHLIST_REQ_QTY

9.3

Double

 

Requested quantity.

WISHLIST_REF

30

String

 

Reference

WISHLIST_EMAIL

45

String

 

Email address.

WISHLIST_EXP_DAYS

3

Integer

 

Expire in days.

WISHLIST_LOCATION

2

String

Y

Location.

 

Input Parameters

Parameter

Type

Detail

ChangeWishListResult

Integer

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

 

Code Example

The following sample code will change a wish list record’s email address and requested quantity.

 

Dim Service As New webServicescuswl.ElicuswlService

Dim ChangeWishListResult As Integer

Dim Input As New webServicescuswl.ChangeWishListInput

Input.WISHLIST_CUST_NO = “000456”

Input.WISHLIST_SHIPTO_NO = “0001”

Input.WISHLIST_CONTACTID = 123456789

Input.WISHLIST_PROD_CAT = “ACC”

Input.WISHLIST_ITEM_NO = “049”

Input.WISHLIST_SEQ_NO = 1

Input.WISHLIST_EMAIL = “abc@outlook.com”

Input.WISHLIST_REQ_QTY = 4.5

ChangeWishListResult = Service.ChangeWishList(“”, “”, Input)

If ChangeWishListResult = 0 Then

   lblResult.Text = “WishList Changed.”

Else

  lblResult.Text = “Error”

  lblErrorCode.Text = ChangeWishListResult.ToString

End If

 

DeleteWishList

This method deletes one wish list record.

Usage:

DeleteWishListResult = A.DeleteWishList(UserName, UserPassword, WISHLIST_CUST_NO, WISHLIST_SHIPTO_NO, WISHLIST_CONTACTID, WISHLIST_PROD_CAT, WISHLIST_ITEM_NO, WISHLIST_SEQ_NO)

Parameters UserName and UserPassword are not used at this moment.

 

Input Parameters

Parameter

Length

Type

Upper

Detail

WISHLIST_CUST_NO

6

String

Y

Required.

WISHLIST_SHIPTO_NO

4

String

Y

Required.

WISHLIST_CONTACTID

9

Integer

 

Required.

WISHLIST_PROD_CAT

3

String

Y

Required.

WISHLIST_ITEM_NO

15

String

Y

Required.

WISHLIST_SEQ_NO

4

Integer

 

Required.

 

Output Parameters

Parameter

Type

Detail

DeleteWishListResult

Integer

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

 

Code Example

The following sample code will delete a wish list record.

 

Dim Service As New webServicescuswl.ElicuswlService

Dim DeleteWishListResult As Integer

Dim WISHLIST_CUST_NO As String = “000456”

Dim WISHLIST_SHIPTO_NO As String = “0001”

Dim WISHLIST_CONTACTID As Integer = 123456789

Dim WISHLIST_PROD_CAT As String = “ACC”

Dim WISHLIST_ITEM_NO As String = “049”

Dim WISHLIST_SEQ_NO As Integer = 1

DeleteWishListResult = Service.DeleteWishList(“”, “”, WISHLIST_CUST_NO, WISHLIST_SHIPTO_NO, WISHLIST_CONTACTID, WISHLIST_PROD_CAT, WISHLIST_ITEM_NO, WISHLIST_SEQ_NO)

If DeleteWishListResult = 0 Then

   lblResult.Text = “WishList Deleted.”

Else

  lblResult.Text = “Error”

  lblErrorCode.Text = DeleteWishListResult.ToString

End If

 

ViewCustomerWishList

This method returns all customer wish list records for provided customer.

Usage:

ViewCustomerWishListResult = A.ViewCustomerWishList(UserName, UserPassword, WISHLIST_CUST_NO)

Parameters UserName and UserPassword are not used at this moment.

 

Input Parameters

Parameter

Length

Type

Upper

Detail

WISHLIST_CUST_NO

6

String

Y

Required.

 

ViewCustomerWishListResult Structure

Property

Type

Detail

ReturnCode

Integer

Contains return code. Zero means OK; for other return codes, please see “ElicuswlService 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.

CustomerWishRecord()

CustomerWishRecord

Contains wish list records. See below for the structure.

NoOfItem

Integer

Number of items in CustomerWishRecord array.

 

CustomerWishRecord Structure

Property

Type

Detail

WISHLIST_CUST_NO

String

Required. System will automatically pad zeros to the customer number.

WISHLIST_SHIPTO_NO

String

Ship-To number.

WISHLIST_CONTACTID

Integer

Contact ID.

WISHLIST_PROD_CAT

String

Product category.

WISHLIST_ITEM_NO

String

Item number.

WISHLIST_SEQ_NO

Integer

Sequence number.

WISHLIST_ITEM_NO1

String

This is the same as WISHLIST_ITEM_NO.

WISHLIST_CUST_NO1

String

This is the same as WISHLIST_CUST_NO.

WISHLIST_SHIPTO_NO1

String

This is the same as WISHLIST_SHIPTO_NO.

WISHLIST_CONTACTID1

Integer

This is the same as WISHLIST_CONTACTID.

WISHLIST_EVT_ACT_ID

Integer

Event action id.

WISHLIST_CREATE_DT

Date

Create date.

WISHLIST_LST_REQ_DT

Date

Last require date.

WISHLIST_EXP_DT

Date

Expiration date.

WISHLIST_REQ_QTY

Double

Requested quantity.

WISHLIST_REF

String

Reference.

WISHLIST_EMAIL

String

Email address.

WISHLIST_EXP_DAYS

Integer

Expire in days.

WISHLIST_LOCATION

String

Location.

WISHLIST_FILLER

String

Usually empty.

 

Code Example

The following sample code will return wish lists for customer “000456.”

 

Dim Service As New webServicescuswl.ElicuswlService

Dim Result As New webServicescuswl.ViewCustomerWishListResult

Dim WISHLIST_CUST_NO As String = “000456”

Result = Service.ViewCustomerWishList(“”, “”, WISHLIST_CUST_NO)

If Result.ReturnCode = 0 Then

   lblResult.Text = “ The First Returned Record: SHIPTO_NO= ” & _

                    Result.CustomerWishRecord(0).WISHLIST_SHIPTO_NO & _

                   “ ,CONTACTID = ” & _

                    Result.CustomerWishRecord(0).WISHLIST_CONTACTID & _

                   “ ,PROD_CAT = ” & _

                    Result.CustomerWishRecord(0).WISHLIST_PROD_CAT

Else

  If Result.ReturnCode = 9 Then

     lblResult.Text = “No Record Found”

  Else

     lblResult.Text = “Error”

     lblErrorCode.Text = Result.ReturnCode.ToString

  End If

End If

 

ElicuswlService Return Code

0 = OK

1 = File Error

2 = Data Missing (Customer No & Item No Required)

3 = Customer Not On File

4 = Ship To Not On File

5 = Item Not On File

6 = Event Action Not On File

7 = Customer Wish List Not On File

8 = Customer No. Missing (Inquiry Mode)

9 = No Record Found (Inquiry Mode)

CLS

Feedback and Knowledge Base