Project

General

Profile

Programming Guide » History » Version 13

chin-yeh, 10/31/2011 02:13 PM

1 1 chin-yeh
{{toc}}
2
3
h1. Programming Guide
4 2 chin-yeh
5 3 chin-yeh
* [[programming_guide#Steps-By-Steps|Steps-By-Steps]] - describes how to integrate the SP web services APIs.
6
* [[API References]] - the API references of all of the APIs mentioned in the [[programming_guide#Steps-By-Steps|Steps-By-Steps]]
7
8 4 chin-yeh
_Demo Application:_
9
> http://192.168.2.68:8080/sp-test/index.html
10
11 5 chin-yeh
Below is the list of libraries needed:
12 13 chin-yeh
* sp-stub - _download the latest stable version from_ "Nexus":http://192.168.2.13:8081/nexus/index.html
13
* sp-client - _download the latest stable version from_ "Nexus":http://192.168.2.13:8081/nexus/index.html
14 5 chin-yeh
15 3 chin-yeh
h2. Steps-By-Steps
16
17
h3. Query Utilization Status
18
19 6 chin-yeh
This [[API_References#Query-utilization-status-of-the-Special-Bundle-Set|API]] checks if the member has already purchased the special bundle set.
20 1 chin-yeh
21 6 chin-yeh
*Steps:*
22
# This API requires the parameters:
23
** memberId
24
** countryCode
25 12 chin-yeh
# Pass the required parameters into the method, [[API_References#Query-utilization-status-of-the-Special-Bundle-Set|isUtilized]]
26 7 chin-yeh
# If the returned *status* is:
27 12 chin-yeh
** *true* means it's been utilized
28
** *false* means it has not been utilized
29 6 chin-yeh
30
31 3 chin-yeh
h3. Utilize the Special Bundle Set
32 1 chin-yeh
33 6 chin-yeh
This [[API_References#Utilize-the-Special-Bundle-Set|API]] informs SP web services when the member has purchased the special bundle set.
34
35
*Steps:*
36
# [[API_References#Utilize-the-Special-Bundle-Set|Query the utilization status of the special bundle set]]
37
## if *not yet utilized*
38
### pass the following parameters to the method, [[API_References#Utilize-the-Special-Bundle-Set|flagSpecialSetUtilization]]:
39
**** dbConnection
40
**** orderId
41
**** countryCode
42
**** memberId
43
**** trxDate
44 11 chin-yeh
### if the returned *status* is *0000*, it has been successfully processed
45 6 chin-yeh
## if *utilized*, inform the member that he/she has purchased the bundle set.
46
47 3 chin-yeh
h3. Return or Exchange Special Bundle Set
48 1 chin-yeh
49 6 chin-yeh
Invokes this [[API_References#Return-the-Special-Bundle-Set|API]] when the member return or exchange the special bundle set.
50
51
*Steps:*
52
# there's no need to query the utilization status
53
# pass the following parameters to the method, [[API_References#Return-the-Special-Bundle-Set|unflagSpecialSetUtilization]]:
54
** dbConnection
55
** orderId
56
** countryCode
57
** memberId
58
** trxDate
59 11 chin-yeh
# if the returned *status* is *0000*, it has been successfully processed
60 3 chin-yeh
61 2 chin-yeh
h2. API References
62
63
See [[API References]]