Update Coupon
This API is used to update a coupon by specifying the coupon id.
API Details
Signature of API call
connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);
See details about invoking API in general
Parameter 1 - URI
couponService.do
Parameter 2 - UserName
Username of the site admin
Parameter 3 - Request Parameters
| Name | Value |
| dispatch | updateCoupon |
| xml | true |
| id | Coupon id |
| valueCount | number of times the coupon can be used (can't be less than already used count) |
| valueAmount |
numeric total discount amount value for coupon (if type is AMOUNT) numeric total amount (credit) available via coupon (if type is TOTAL_AMOUNT) |
| valuePercent | numeric % discount value for coupon (if type is PERCENT) |
| expDate | Expiration date of the coupon (optional), represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds |
| setMembershipExpiration |
Boolean (true | false) If true - sets user's membership expiration same as coupon expiration. |
| addUserToCouponsGroup |
Boolean (true | false) If true - adds the user to coupon's authorized group if the user is not already a member |
| requireApproval |
Boolean (true | false) If true - usage will require coupon's authorized group admin to approve |
| previewAccessOnly |
Boolean (true | false) If true - the user will get only limited time access to course session / program session |
| status | ACTIVE | INACTIVE (only active coupon can be used) |
| comment | Comments |
Response
Response on successfully updating the coupon
HTTP Response Code = HttpServletResponse.SC_OK
Response XML
<response code="0">
<msgs>
<msg>
<code>0223</code>
<value>
<![CDATA[Coupon updated successfully]]>
</value>
</msg>
</msgs>
<msgs>
<msg>
<code>0223</code>
<value>
<![CDATA[Coupon updated successfully]]>
</value>
</msg>
</msgs>
</response>
Code Snippet
/* Check API Call for detail */
Map<String, String> parameters = new HashMap<String, String>();
populateMapForCouponUpdate(parameters);
String result = connection.invokeApi("couponService.do", "adminusername", parameters);
System.out.println(result);
System.out.println(result);
private void populateMapForCouponUpdate(Map<String, String> parameters) {
parameters.put("dispatch", "updateCoupon");
parameters.put("xml", String.valueOf(true));
parameters.put("id", "xxxx-xxxx-xxxx-xxxx");
parameters.put("valueCount", "1234");
parameters.put("expDate", "1495163497116");
}
parameters.put("dispatch", "updateCoupon");
parameters.put("xml", String.valueOf(true));
parameters.put("id", "xxxx-xxxx-xxxx-xxxx");
parameters.put("valueCount", "1234");
parameters.put("expDate", "1495163497116");
}
Rating:
Related Pages
Group Management
Javascript
- Customization On Payment Page
- Validate IP Address while accessing the course
- UI Customization JavaScript Functions
- Verify Custom properties during Test Taking
- Verifying User Properties During Test
- JS Example
- example_custom_scripts
- Test Taking - Customization using callback mechanism
- Cms Calendar Example
Reports
Enrollment Management
- API - Update Event Subscription
- API - Create ExamTestInstance
- Update Program Member - via Program Session Id
- Update Program Member
- API - Self Enroll in Course Session
- Update Course Session Member
- API - Self Enroll in Program Session
- API - Self Enroll in Event
- API - Enroll Users in Course Session
- API - Enroll Users in Program Session
- API - Enroll Users in Event
- API - Enroll Users in Program
Other
Introduction
Report
- Get Sites Metadata
- Get Open Learning Items List
- API - Program Enrollment Summary
- API - Course Enrollment Summary
- Get Catalog Items List
- API - Course Session Members list
- API - Program Members List
- Event participants list
- Api - Test Attempts (Test Instances) List
- Test instance details list
- Api - Non Subscribed Event List
- Api - Subscribed Event List
- API - List All Report Schedules
- API - Get Latest Report Content For A Given Schedule ID
- API - Get Report Content For A Given Report ID
- API - List Reports For A Given Schedule
User Management
- API - User list
- API - Get user details
- Api - User Creation
- API - Create User (With Custom Properties)
- API - Update User
- API - Rename User
- API - Add user to group(s)
- API - Remove user from group(s)
- Merge User Accounts
- API - Activate User
- API - Deactivate User
- API - Change User's Origin Site
- Api - User Login (Creating User Session)
eCommerce
API Documentation
Examples
- User Creation
- User Update
- User List
- Get User Details
- Add User to Group(s)
- Remove User from Group(s)
- User Activate
- User Deactivate
- User Login
- Group List
- Group Membership
- Course Subscription(Coupon Code)
- Subscribed Events List
- Non Subscribed Events List
- Test Instances in Microsite
- Forum APIs
- Javascript Example
Client Example
Quick Links
- Home
- Getting Started
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)
Group Management
Javascript
- Customization On Payment Page
- Validate IP Address while accessing the course
- UI Customization JavaScript Functions
- Verify Custom properties during Test Taking
- Verifying User Properties During Test
- JS Example
- example_custom_scripts
- Test Taking - Customization using callback mechanism
- Cms Calendar Example
Reports
Enrollment Management
- API - Update Event Subscription
- API - Create ExamTestInstance
- Update Program Member - via Program Session Id
- Update Program Member
- API - Self Enroll in Course Session
- Update Course Session Member
- API - Self Enroll in Program Session
- API - Self Enroll in Event
- API - Enroll Users in Course Session
- API - Enroll Users in Program Session
- API - Enroll Users in Event
- API - Enroll Users in Program
Other
Introduction
Report
- Get Sites Metadata
- Get Open Learning Items List
- API - Program Enrollment Summary
- API - Course Enrollment Summary
- Get Catalog Items List
- API - Course Session Members list
- API - Program Members List
- Event participants list
- Api - Test Attempts (Test Instances) List
- Test instance details list
- Api - Non Subscribed Event List
- Api - Subscribed Event List
- API - List All Report Schedules
- API - Get Latest Report Content For A Given Schedule ID
- API - Get Report Content For A Given Report ID
- API - List Reports For A Given Schedule
User Management
- API - User list
- API - Get user details
- Api - User Creation
- API - Create User (With Custom Properties)
- API - Update User
- API - Rename User
- API - Add user to group(s)
- API - Remove user from group(s)
- Merge User Accounts
- API - Activate User
- API - Deactivate User
- API - Change User's Origin Site
- Api - User Login (Creating User Session)
eCommerce
API Documentation
Examples
- User Creation
- User Update
- User List
- Get User Details
- Add User to Group(s)
- Remove User from Group(s)
- User Activate
- User Deactivate
- User Login
- Group List
- Group Membership
- Course Subscription(Coupon Code)
- Subscribed Events List
- Non Subscribed Events List
- Test Instances in Microsite
- Forum APIs
- Javascript Example
Client Example
Quick Links
- Home
- Getting Started
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)
