• Table of contents
• Programming Guide
  • Steps-By-Steps
    • Query Utilization Status
    • Utilize the Special Bundle Set
    • Return or Exchange Special Bundle Set
  • API References

Programming Guide¶

• Steps-By-Steps - describes how to integrate the SP web services APIs.
• API References - the API references of all of the APIs mentioned in the Steps-By-Steps

Demo Application:

http://192.168.2.68:8080/sp-test/index.html

Below is the list of libraries needed:

• sp-stub - download the latest version from Nexus
• sp-client - download the latest version from Nexus

Steps-By-Steps¶

Query Utilization Status¶

This API checks if the member has already purchased the special bundle set.

Steps:

1. This API requires the parameters:
   • memberId
   • countryCode
2. Pass the required parameters into the method, queryUtilizationStatus
3. If the returned status is:
   • 0000
     1. then check the returned value, isUtilized, true means has been utilized
   • any other codes
     1. do not proceed as it could be system error or programming error

Utilize the Special Bundle Set¶

This API informs SP web services when the member has purchased the special bundle set.

Steps:

1. Query the utilization status of the special bundle set
   1. if not yet utilized
      1. pass the following parameters to the method, flagSpecialSetUtilization:
         • dbConnection
         • orderId
         • countryCode
         • memberId
         • trxDate
      2. if the returned status is 0000, it has been successfully processed
   2. if utilized, inform the member that he/she has purchased the bundle set.

Return or Exchange Special Bundle Set¶

Invokes this API when the member return or exchange the special bundle set.

Steps:

1. there's no need to query the utilization status
2. pass the following parameters to the method, unflagSpecialSetUtilization:
   • dbConnection
   • orderId
   • countryCode
   • memberId
   • trxDate
3. if the returned status is 0000, it has been successfully processed

API References¶

See API References