Update Event Subscription
This API can be used to update custom properties of event subscription and update subscription status (from Active to Cancelled)
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
enrollmentService.do
Parameter 2 - UserName
Username of any site administrator
Parameter 3 - Request Parameters
Name | Value |
dispatch |
updateEventSubscription |
subscriptionId |
event subscription Id |
subscriptionStatus |
Subscription status that will be updated. Only allowed value is 'CANCELLED' |
customUpdPropMap['property1Name'], customUpdPropMap['property2Name'], customUpdPropMap['property3Name'] ... ... |
Custom property values to be updated at event subscription level. Each property name should be passed as "customUpdPropMap['name of property']" These custom properties must be first defined in microsite, using the Site Admin->Custom Properties->Event Participant properties. |
Response
1. Response on successfully adding user to group
HTTP Response Code = HttpServletResponse.SC_OK
Response XML
<response code="0">
<msgs>
<msg>
<code>0</code>
<value><![CDATA[Success]]></value>
</msg>
</msgs>
</response>
2. Response for unauthorized access
HTTP Response Code = HttpServletResponse.SC_UNAUTHORIZED
Response XML
<response code="-1">
<msgs>
<msg>
<code>0005</code>
<value><![CDATA[You are not allowed to perform this action.]]></value>
</msg>
</msgs>
</response>
Code Snippet
/* Check API Call for detail generic code */
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("subscriptionId", "81154232-7e81-11e4-b5ad-fb29daca6745");
parameters.put("subscriptionStatus", "CANCELLED");
parameters.put("dispatch", "updateEventSubscription");
parameters.put("customUpdPropMap['property1Name']","property1Value");
parameters.put("customUpdPropMap['property2Name']","property2Value");
String retStr = connection.invokeApi("enrollmentService.do", "chenry", parameters);
System.out.println(retStr);
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
Quick Links
- Home
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)
- EduBrite Mobile App for iPad
Gilly - EduBrite plugin for Confluence
Demo Url: http://gillydemo..edubrite.com
User: demo1, demo2
Password: password
EduBrite Mobile app for iPad
Download the app from app store
Demo Microsite: ipaddemo.edubrite.com
Signup from the app by selecting any username, and entering above demo url as training site url
EduBrite Business Edition
Demo Url: http://learnzone.edubrite.com
Signup as a user (trainee) and see the whole experience of enrolling and running the courses and tests
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
Quick Links
- Home
- Knowledgebase
- Video Tutorials
- Google Apps Integration
- Gilly (Plugin for Atlassian Confluence)
- EduBrite Mobile App for iPad
Gilly - EduBrite plugin for Confluence
Demo Url: http://gillydemo..edubrite.com
User: demo1, demo2
Password: password
EduBrite Mobile app for iPad
Download the app from app store
Demo Microsite: ipaddemo.edubrite.com
Signup from the app by selecting any username, and entering above demo url as training site url
EduBrite Business Edition
Demo Url: http://learnzone.edubrite.com
Signup as a user (trainee) and see the whole experience of enrolling and running the courses and tests