Project

General

Profile

Specification » History » Version 3

Soh Keong, 08/11/2021 04:10 PM

1 1 Soh Keong
{{toc}}
2
3
h1. Specification
4
5
h1. Programming Guide
6
7
h3. Jar version 
8
9
|_. version |_. Description  |
10
| 1.0       | Init           |
11
12
h3. Jar File Download
13
14
"Jar":
15
"Properties":
16
17
h3. properties file
18
19
* *service.properties*
20
21
# *json.url*                - Dotnet team URL
22 2 Soh Keong
# *json.key*                - provided by Dotnet
23
# *aes.key*                 - provided by Dotnet
24 1 Soh Keong
# *connection.timeout*      - set connection timeout
25
# *connection.read.timeout* - set connection read timeout
26
27
h2. Methods
28
29
h3. Common Instance
30
31
<pre>
32
com.vouchertw.service.VoucherService service = new com.vouchertw.service.VoucherService();
33
</pre>
34
35
36
h3. addVoucher
37
38
<pre>
39
com.vouchertw.bean.ResponseBean result = service.addVoucher(VoucherTransactionBean bean);
40
</pre>
41
42
* *com.vouchertw.bean.VoucherTransactionBean*
43
> * *stockistId*   - String
44
> * *memberId*     - String
45
> * *countryId*    - String
46
> * *orderId*      - String
47
> * *orderDate*    - java.time.LocalDate
48
> * *voucherSet*   - Set<VoucherBean>
49
>> * *voucherCode*   - String
50
>> * *startDate*     - java.time.LocalDate
51
>> * *expiryDate*    - java.time.LocalDate
52
>> * *amount*        - double
53
>> * *point*         - int
54
>> * *voucherName*   - String
55
>> * *promoCode*     - String
56
>> * *token*         - System auto assign
57 2 Soh Keong
58
* *com.vouchertw.bean.ResponseBean*
59
> * *errorCode* - String
60
> * *errorMsg*  - String
61
62
h3. getVoucherByMember
63
64
<pre>
65
com.vouchertw.bean.MemberResponseBean result = service.getVoucherByMember(MemberRequestBeanbean);
66
</pre>
67
68
* *com.vouchertw.bean.MemberRequestBean*
69
> * *stockistId*   - String
70
> * *memberId*     - String
71
> * *countryId*    - String
72
>> * *token*       - System auto assign
73
74
* *com.vouchertw.bean.MemberResponseBean*
75
> * *errorCode*    - String
76
> * *errorMsg*     - String
77
> * *voucherSet*   - Set<VoucherBean>
78
>> * *voucherCode*   - String
79
>> * *startDate*     - java.time.LocalDate
80
>> * *expiryDate*    - java.time.LocalDate
81
>> * *amount*        - double
82
>> * *point*         - int
83
>> * *voucherName*   - String
84
>> * *promoCode*     - String
85
>> * *orderId*       - String
86
>> * *stockistId*    - String
87
>> * *errorCode*     - String
88
>> * *errorMsg*      - String
89 3 Soh Keong
90
h3. getActiveUtilizeVoucherByMember
91
92
<pre>
93
com.vouchertw.bean.MemberResponseBean result = service.getActiveUtilizeVoucherByMember(VoucherRequestBean bean);
94
</pre>
95
96
* *com.vouchertw.bean.VoucherTransactionBean*
97
> * *stockistId*      - String
98
> * *memberId*        - String
99
> * *countryId*       - String
100
> * *voucherPromoId*  - String (Optional)
101
> * *voucherSet*      - Set<VoucherBean>
102
>> * *voucherCode*      - String
103
>> * *promoCode*     - String
104
105
* *com.vouchertw.bean.MemberResponseBean*
106
> * *errorCode*    - String
107
> * *errorMsg*     - String
108
> * *voucherSet*   - Set<VoucherBean>
109
>> * *voucherCode*   - String
110
>> * *startDate*     - java.time.LocalDate
111
>> * *expiryDate*    - java.time.LocalDate
112
>> * *amount*        - double
113
>> * *point*         - int
114
>> * *voucherName*   - String
115
>> * *promoCode*     - String
116
>> * *orderId*       - String
117
>> * *stockistId*    - String
118
>> * *errorCode*     - String
119
>> * *errorMsg*      - String