API calls return a http response code, and XML message. XML consists of a success or failure indicator as well as detailed messages, besides the actual data returned by the API.
Http Response Codes
SC_OK - 200
SC_FORBIDDEN - 403
SC_UNAUTHORIZED - 401
SC_NOT_FOUND - 404
XML Response Code
xml response code is returned in the root level xml node in the response. E.g. <response code="0">
SUCCESS - 0
FAILURE - -1
Message Code
Message code is contained inside the msgs element within response. Here is an example
<msgs>
<msg>
<code>0</code>
<value>
<![CDATA[Success]]>
</value>
</msg>
</msgs>
A common success code used by all service/methods is -
SUCCESS - 0
Besides this, each service method uses different codes as per the functionality provided by that service/method.
User Service
GENERIC_ERROR - 0026
NOT_FOUND - 0004
USERNAME_NOT_UNIQUE - 0017
EMAIL_NOT_UNIQUE - 0209
USER_ADDED_SUCCESSFULLY - 0018
USER_UPDATED_SUCCESSFULLY - 0172
ACTIVATED_SUCCESSFULLY - 0092
INACTIVATED_SUCCESSFULLY - 0093
MERGED_SUCCESSFULLY - 0224
GRP_USER_ADD_SUCCESS - 0031
GRP_USER_DEL_SUCCESS - 0032
ORIGIN_SITE_UPDATED_SUCCESSFULLY - 0212
Group Service
GRP_USER_ADD_SUCCESS - 0031
GRP_USER_DEL_SUCCESS - 0032
GENERIC_ERROR - 0026
NOT_FOUND - 0004
GROUP_UPDATED_SUCCESSFULLY - 0211
UNSUPPORTED_OP - 0210
GROUP_UPDATED_SUCCESSFULLY - 0211
INVALID_GROUP_TEMPLATE - 0219
INVALID_PATH - 0220
GROUP_CREATED_SUCCESSFULLY - 0218
GROUP_DELETED_SUCCESSFULLY - 0221
Catalog Service
GROUP_CONTENT_NOT_VISIBLE - 0192
Connect Service
CONNECT_NOT_SUCCESSFUL - 0154
SESSION_NOT_VALID - 0174
CONNECT_SUCCESSFUL - 0152
Enrollment Service
GENERIC_ERROR - 0026
PM_UPDATED_SUCCESSFULLY - 0226
COURSE_SESSION_SUBSCRIBED - 0153
EVENT_SUBSCRIBED - 0193
PROGRAM_SESSION_SUBSCRIBED - 0194
Report Service
GENERIC_ERROR - 0026
Coupon Service
INVALID_PATH - 0220
COUPON_CREATED_SUCCESSFULLY - 0222
GENERIC_ERROR - 0026
DELETED_SUCCESSFULLY - 0089
COUPON_UPDATED_SUCCESSFULLY - 0223
Event Service
COURSE_SESSION_SUBSCRIBED - 0153
GENERIC_ERROR - 0026
GROUP_NOT_VISIBLE - 0063
GROUP_EXPIRED - 0076
Signup Service
GENERIC_ERROR - 0026
USER_ADDED_SUCCESSFULLY - 0018
Signin Service
ACCOUNT_INACTIVE - 0002
Signup Service
GENERIC_ERROR - 0026
USER_ADDED_SUCCESSFULLY - 0018
Forgot Password Service
CONNECT_NOT_SUCCESSFUL - 0154
GENERIC_ERROR - 0026
PASSWORD_RESET_NOT_ALLOWED - 0151
PASSWD_EMAILED - 0006
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)