Project

General

Profile

Specification » History » Revision 4

Revision 3 (Soh Keong, 10/26/2020 03:10 PM) → Revision 4/5 (Soh Keong, 10/26/2020 04:00 PM)

{{toc}} 

 h1. Specification 

 h2. Programming Guide 

 h3. Jar version  

 |_. version |_. Description    | 
 | 1.6         | Init             | 

 h3. Jar File Download 

 "Jar":/redmine/attachments/download/489/vmcnOnlineService-1.6.jar 
 "Lib":/redmine/attachments/download/491/lib.rar 
 "Properties":/redmine/attachments/download/490/service.properties 

 h3. properties file 

 * *service.properties* 

 # *json.url*                  - China server URL 
 # *online.key*                - for encryption  
 # *connection.timeout*        - set connection timeout 
 # *connection.read.timeout* - set connection read timeout 


 h1. Methods 

 h2. Voucher 

 <pre> 
 com.vmcn.online.service.VoucherService service = new com.vmcn.online.service.VoucherService(); 
 </pre> 

 h3. getActiveVoucherByMemberId / getActiveVoucherByVoucherCode / getVoucherByMemberId / getVoucherByMemberIdVoucherType 

 <pre> 
 com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getVoucherByMemberId(String memberId) 
 com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getActiveVoucherByMemberId(String memberId) 
 com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getActiveVoucherByVoucherCode(String voucherCode) 
 com.vmcn.online.model.VoucherByMemberIdResultBean resultBean = service.getVoucherByMemberIdVoucherType(String memberId, String voucherType) 
 </pre> 

 * *com.vmcn.online.model.VoucherByMemberIdResultBean* 
 > * *responseCode*         - String 
 > * *responseMessage*      - String 
 > * *voucherBeanList*      - List<VoucherFullDetailBean> 
 >> * *earnStoreCode*         - String 
 >> * *earnInvoiceNo*         - String 
 >> * *earnInvoiceDate*       - Date 
 >> * *earnMemberId*          - String 
 >> * *utilizeStoreCode*      - String 
 >> * *utilizeInvoiceNo*      - String 
 >> * *utilizeInvoiceDate*    - Date 
 >> * *utilizeMemberId*       - String 
 >> * *effectiveDate*         - Date 
 >> * *expiryDate*            - Date 
 >> * *amount*                - double 
 >> * *memberId*              - String 
 >> * *lockPeriod*            - int 
 >> * *voucherCode*           - String 
 >> * *voucherType*           - String 
 >> * *status*                - String 

 h3. queryVoucher 

 <pre> 
 com.vmcn.online.model.VoucherQueryResultBean resultBean = service.queryVoucher(VoucherQueryBean bean)  
 </pre> 

 * *com.vmcn.online.model.VoucherQueryBean* 
 > * *voucherList*         - List<VoucherCommonBean> 
 >> * *voucherCode*          - String 
 >> * *voucherType*          - String 

 * *com.vmcn.online.model.VoucherQueryResultBean* 
 > * *responseCode*         - String 
 > * *responseMessage*      - String 
 > * *voucherBeanList*      - List<VoucherDetailBean> 
 >> * *voucherCode*          - String 
 >> * *voucherType*          - String 
 >> * *status*               - String 
 >> * *effectiveDate*         - Date 
 >> * *expiryDate*            - Date 
 >> * *amount*                - double 
 >> * *memberId*              - String 


 h3. updateVoucher / voidVoucher 

 <pre> 
 com.vmcn.online.model.ResultBean resultBean = service.updateVoucher(VoucherUtilizeBean bean) 
 com.vmcn.online.model.ResultBean resultBean = service.ResultBean voidVoucher(VoucherUtilizeBean bean) 
 </pre> 

 * *com.vmcn.online.model.VoucherUtilizeBean* 
 > * *orderId*                  - String 
 > * *orderCreateDatetime*      - Date 
 > * *memberId*                 - String 
 > * *storeCode*                - String 
 > * *modifyBy*                 - String 
 > * *voucherList*              - List 
 >> * *voucherCode*               - String 
 >> * *voucherType*               - String 

 * *com.vmcn.online.model.VoucherQueryResultBean* 
 > * *responseCode*         - String 
 > * *responseMessage*      - String 


 h2. Scheme 

 <pre> 
 com.vmcn.online.service.SchemeService service = new com.vmcn.online.service.SchemeService(); 
 </pre> 

 h3. queryScheme 

 <pre> 
 com.vmcn.online.model.SchemeResultBean resultBean = service.queryScheme(SchemeBean bean) 
 </pre> 

 * *com.vmcn.online.model.SchemeBean* 
 > * *scheme*        - String 
 > * *memberId*      - String 

 * *com.vmcn.online.model.SchemeResultBean* 
 > * *responseCode*        - String 
 > * *responseMessage*     - String 
 > * *balance*             - int 
 > * *totalTransaction*    - int 
 > * *maxQty*              - int 
 > * *maxTransaction*      - int 
 > * *maxPerTransaction* - int 


 h3. com.vmcn.online.model.PostBean resultBean = service.updateScheme(SchemeBean bean) 

 * *com.vmcn.online.model.SchemeBean* 
 > * *scheme*        - String 
 > * *memberId*      - String 

 * *com.vmcn.online.model.PostBean* 
 > * *responseCode*         - String 
 > * *responseMessage*      - String 


 h2. VP 

 <pre> 
 com.vmcn.online.service.VPServiceservice = new com.vmcn.online.service.VPService(); 
 </pre> 

 h3. queryVP / lockVP / updateVP 

 <pre> 
 com.vmcn.online.model.VPResultBean resultBean = service.queryVP(String memberId); 
 com.vmcn.online.model.VPResultBean resultBean = service.lockVP(VPTransactionBean bean) 
 com.vmcn.online.model.VPResultBean resultBean = service.updateVP(VPTransactionBean bean) 
 </pre> 

 * *com.vmcn.online.model.VPTransactionBean* 
 > * *memberId*      - String 
 > * *orderId*       - String 
 > * *orderDate*     - date 
 > * *createdBy*     - String 
 > * *trxCode*       - String 
 > * *vpEarn*        - int 
 > * *vpUtilize*     - int 

 * *com.vmcn.online.model.VPResultBean* 
 > * *responseCode*        - String 
 > * *responseMessage*     - String 
 > * *vpBalance*           - int 
 > * *lock*                - boolean 

 h2. Passcode 

 <pre> 
 com.vmcn.online.service.PasscodeService service = new com.vmcn.online.service.PasscodeService(); 
 </pre> 

 h3. queryPasscode / utilizePasscode 

 <pre> 
 com.vmcn.online.model.PostBean resultBean = service.queryPasscode(String passcode) 
 com.vmcn.online.model.PostBean resultBean = service.utilizePasscode(PasscodeBean bean) 
 </pre> 

 * *com.vmcn.online.model.PasscodeBean* 
 > * *passcode*      - String 
 > * *createdBy*     - String 

 * *com.vmcn.online.model.PostBean* 
 > * *responseCode*        - String 
 > * *responseMessage*     - String