Project

General

Profile

Specification » History » Version 3

Soh Keong, 10/26/2020 03:10 PM

1 3 Soh Keong
{{toc}}
2
3 1 Soh Keong
h1. Specification
4
5 3 Soh Keong
h2. Programming Guide
6 1 Soh Keong
7
h3. Jar version 
8
9
|_. version |_. Description  |
10
| 1.6       | Init           |
11
12
h3. Jar File Download
13
14
"Jar":/redmine/attachments/download/489/vmcnOnlineService-1.6.jar
15
"Lib":/redmine/attachments/download/491/lib.rar
16
"Properties":/redmine/attachments/download/490/service.properties
17
18
h3. properties file
19
20
* *service.properties*
21
22 2 Soh Keong
# *json.url*                - China server URL
23
# *online.key*              - for encryption 
24
# *connection.timeout*      - set connection timeout
25
# *connection.read.timeout* - set connection read timeout
26 1 Soh Keong
27
28 3 Soh Keong
h1. Methods
29 1 Soh Keong
30 3 Soh Keong
h2. Voucher
31
32
<pre>
33
com.vmcn.online.service.VoucherService service = new com.vmcn.online.service.VoucherService();
34
</pre>
35
36
h3. getActiveVoucherByMemberId / getActiveVoucherByVoucherCode / getVoucherByMemberId / getVoucherByMemberIdVoucherType
37
38
<pre>
39
com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getVoucherByMemberId(String memberId)
40
com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getActiveVoucherByMemberId(String memberId)
41
com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getActiveVoucherByVoucherCode(String voucherCode)
42
com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getVoucherByMemberIdVoucherType(String memberId, String voucherType)
43
</pre>
44
45
* *com.vmcn.online.model.VoucherByMemberIdResultBean*
46
> * *responseCode*       - String
47
> * *responseMessage*    - String
48
> * *voucherBeanList*    - List<VoucherFullDetailBean>
49
>> * *earnStoreCode*       - String
50
>> * *earnInvoiceNo*       - String
51
>> * *earnInvoiceDate*     - Date
52
>> * *earnMemberId*        - String
53
>> * *utilizeStoreCode*    - String
54
>> * *utilizeInvoiceNo*    - String
55
>> * *utilizeInvoiceDate*  - Date
56
>> * *utilizeMemberId*     - String
57
>> * *effectiveDate*       - Date
58
>> * *expiryDate*          - Date
59
>> * *amount*              - double
60
>> * *memberId*            - String
61
>> * *lockPeriod*          - int
62
>> * *voucherCode*         - String
63
>> * *voucherType*         - String
64
>> * *status*              - String
65
66
h3. queryVoucher
67
68
<pre>
69
com.vmcn.online.model.VoucherQueryResultBean resultBean = service.queryVoucher(VoucherQueryBean bean) 
70
</pre>
71
72
* *com.vmcn.online.model.VoucherQueryBean*
73
> * *voucherList*       - List<VoucherCommonBean>
74
>> * *voucherCode*        - String
75
>> * *voucherType*        - String
76
77
* *com.vmcn.online.model.VoucherQueryResultBean*
78
> * *responseCode*       - String
79
> * *responseMessage*    - String
80
> * *voucherBeanList*    - List<VoucherDetailBean>
81
>> * *voucherCode*        - String
82
>> * *voucherType*        - String
83
>> * *status*             - String
84
>> * *effectiveDate*       - Date
85
>> * *expiryDate*          - Date
86
>> * *amount*              - double
87
>> * *memberId*            - String
88
89
90
h3. updateVoucher / voidVoucher
91
92
<pre>
93
com.vmcn.online.model.ResultBean resultBean = service.updateVoucher(VoucherUtilizeBean bean)
94
com.vmcn.online.model.ResultBean resultBean = service.ResultBean voidVoucher(VoucherUtilizeBean bean)
95
</pre>
96
97
* *com.vmcn.online.model.VoucherUtilizeBean*
98
> * *orderId*                - String
99
> * *orderCreateDatetime*    - Date
100
> * *memberId*               - String
101
> * *storeCode*              - String
102
> * *modifyBy*               - String
103
> * *voucherList*            - List
104
>> * *voucherCode*             - String
105
>> * *voucherType*             - String
106
107
* *com.vmcn.online.model.VoucherQueryResultBean*
108
> * *responseCode*       - String
109
> * *responseMessage*    - String
110
111
112
h2. Scheme
113
114
<pre>
115
com.vmcn.online.service.SchemeService service = new com.vmcn.online.service.SchemeService();
116
</pre>
117
118
h3. queryScheme
119
120
<pre>
121
com.vmcn.online.model.SchemeResultBean resultBean = service.queryScheme(SchemeBean bean)
122
</pre>
123
124
* *com.vmcn.online.model.SchemeBean*
125
> * *scheme*      - String
126
> * *memberId*    - String
127
128
* *com.vmcn.online.model.SchemeResultBean*
129
> * *responseCode*      - String
130
> * *responseMessage*   - String
131
> * *balance*           - int
132
> * *totalTransaction*  - int
133
> * *maxQty*            - int
134
> * *maxTransaction*    - int
135
> * *maxPerTransaction* - int
136
137
138
h3. com.vmcn.online.model.PostBean resultBean = service.updateScheme(SchemeBean bean)
139
140
* *com.vmcn.online.model.SchemeBean*
141
> * *scheme*      - String
142
> * *memberId*    - String
143
144
* *com.vmcn.online.model.PostBean*
145
> * *responseCode*       - String
146
> * *responseMessage*    - String