Project

General

Profile

Programming Guide » History » Version 8

chin-yeh, 10/31/2011 10:09 AM

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
* sp-stub - _download the latest version from_ "Nexus":http://192.168.2.13:8081/nexus/index.html
13
* sp-client - _download the latest version from_ "Nexus":http://192.168.2.13:8081/nexus/index.html
14
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
# Pass the required parameters into the method, [[API_References#Query-utilization-status-of-the-Special-Bundle-Set|queryUtilizationStatus]]
26
# If the returned status is:
27
** *0000* 
28 7 chin-yeh
### then check the returned value, *isUtilized*, *true* means has been utilized
29 6 chin-yeh
** _any other codes_
30
### do not proceed as it could be system error or programming error
31
32
33 3 chin-yeh
h3. Utilize the Special Bundle Set
34 1 chin-yeh
35 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.
36
37
*Steps:*
38
# [[API_References#Utilize-the-Special-Bundle-Set|Query the utilization status of the special bundle set]]
39
## if *not yet utilized*
40
### pass the following parameters to the method, [[API_References#Utilize-the-Special-Bundle-Set|flagSpecialSetUtilization]]:
41
**** dbConnection
42
**** orderId
43
**** countryCode
44
**** memberId
45
**** trxDate
46 8 chin-yeh
### if the returned status is *0000*, it has been successfully processed
47 6 chin-yeh
## if *utilized*, inform the member that he/she has purchased the bundle set.
48
49 3 chin-yeh
h3. Return or Exchange Special Bundle Set
50 1 chin-yeh
51 6 chin-yeh
Invokes this [[API_References#Return-the-Special-Bundle-Set|API]] when the member return or exchange the special bundle set.
52
53
*Steps:*
54
# there's no need to query the utilization status
55
# pass the following parameters to the method, [[API_References#Return-the-Special-Bundle-Set|unflagSpecialSetUtilization]]:
56
** dbConnection
57
** orderId
58
** countryCode
59
** memberId
60
** trxDate
61
# if the returned status is *0000*, it has been successfully processed else failed to process.
62 3 chin-yeh
63 2 chin-yeh
h2. API References
64
65
See [[API References]]