This API can be used to get the list of all the scheduled reports.
API Details
Signature of API call
connection.invokeApi(String uri, Map<String, String> requestParameters);
See details about invoking API in general
Parameter 1 - URI
reportService.do
Parameter 2 - Request Parameters
Name | Value |
dispatch | getAllSchedules |
pageSize | Number of items in a page, default value is 10. |
currPage | page number starting from 0 |
numItems | total records in the list, must be specified for 2nd page onwards. You can get the count of records from response of first page. then pass it as-is in subsequent pages. |
Response
1. Response for authorized access
HTTP Response Code = HttpServletResponse.SC_OK
Response XML
<?xml version="1.0" encoding="UTF-8"?> <response code="0"> <msgs> <msg> <code>0</code> <value><![CDATA[Success]]></value> </msg> </msgs> <data> <schedules numItems="28" pageSize="10" currPage="0"> <schedule id="44726599-d966-11e8-8f49-001e6796a8d7"> <name><![CDATA[LastMonthUserReport]]></name> <createdDate>1540589389000</createdDate> <modifiedDate>1540589389000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>USER_REPORT</stdReportType> <recentReportDocId>34ad199e-d96c-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[LastMonthUserReport_Report_October_26_2018_14:29]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1540591939000</recentExecutionDate> </schedule> <schedule id="52923df3-cf1d-11e8-8f49-001e6796a8d7"> <name><![CDATA[AllTestScoresReport-1]]></name> <createdDate>1539458548000</createdDate> <modifiedDate>1539458548000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>ALL_TEST_SCORES_REPORT</stdReportType> <recentReportDocId>7c0cc013-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[AllTestScoresReport-1_Report_October_13_2018_12:22]]></recentReportDocName> <recentExecutionDurationInMillis>2000</recentExecutionDurationInMillis> <recentExecutionDate>1539459479000</recentExecutionDate> </schedule> <schedule id="469167ce-cf1d-11e8-8f49-001e6796a8d7"> <name><![CDATA[TSSummaryReport-1]]></name> <createdDate>1539458527000</createdDate> <modifiedDate>1539458527000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>TEST_SCORES_SUMMARY_REPORT</stdReportType> <recentReportDocId>7c0ec67d-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[TSSummaryReport-1_Report_October_13_2018_12:21]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459477000</recentExecutionDate> </schedule> <schedule id="3c618482-cf1d-11e8-8f49-001e6796a8d7"> <name><![CDATA[TSReport-1]]></name> <createdDate>1539458510000</createdDate> <modifiedDate>1539458510000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>TEST_SCORES_REPORT</stdReportType> <recentReportDocId>7c120550-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[TSReport-1_Report_October_13_2018_12:21]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459476000</recentExecutionDate> </schedule> <schedule id="32a172ca-cf1d-11e8-8f49-001e6796a8d7"> <name><![CDATA[ScormActivityAttemptsReport]]></name> <createdDate>1539458494000</createdDate> <modifiedDate>1539458494000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>SCORM_ACTIVITY_ATTEMPTS_REPORT</stdReportType> <recentReportDocId>7c06d468-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[ScormActivityAttemptsReport_Report_October_13_2018_12:21]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459477000</recentExecutionDate> </schedule> <schedule id="26aae3b6-cf1d-11e8-8f49-001e6796a8d7"> <name><![CDATA[ScormPkgAttemptsReport1]]></name> <createdDate>1539458474000</createdDate> <modifiedDate>1539458474000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>SCORM_PKG_ATTEMPTS_REPORT</stdReportType> <recentReportDocId>7c2ded54-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[ScormPkgAttemptsReport1_Report_October_13_2018_12:20]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459477000</recentExecutionDate> </schedule> <schedule id="191f4f83-cf1d-11e8-8f49-001e6796a8d7"> <name><![CDATA[GradeBookReport-1]]></name> <createdDate>1539458451000</createdDate> <modifiedDate>1539458451000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>GRADEBOOK_REPORT</stdReportType> <recentReportDocId>7be8d3d5-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[GradeBookReport-1_Report_October_13_2018_12:20]]></recentReportDocName> <recentExecutionDurationInMillis>29000</recentExecutionDurationInMillis> <recentExecutionDate>1539459505000</recentExecutionDate> </schedule> <schedule id="f7ad56ca-cf1c-11e8-8f49-001e6796a8d7"> <name><![CDATA[EP-ReportFull]]></name> <createdDate>1539458395000</createdDate> <modifiedDate>1539458395000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>EVENT_PARTICIPANTS_REPORT</stdReportType> <recentReportDocId>7bee68ce-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[EP-ReportFull_Report_October_13_2018_12:19]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459476000</recentExecutionDate> </schedule> <schedule id="f032d1ff-cf1c-11e8-8f49-001e6796a8d7"> <name><![CDATA[EPReport-2]]></name> <createdDate>1539458383000</createdDate> <modifiedDate>1539458383000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>EVENT_PARTICIPANTS_REPORT</stdReportType> <recentReportDocId>7be8ddc6-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[EPReport-2_Report_October_13_2018_12:19]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459476000</recentExecutionDate> </schedule> <schedule id="e6feaa0f-cf1c-11e8-8f49-001e6796a8d7"> <name><![CDATA[EPReport-1]]></name> <createdDate>1539458367000</createdDate> <modifiedDate>1539458367000</modifiedDate> <scheduleFrequency>ONE_TIME</scheduleFrequency> <stdReportType>EVENT_PARTICIPANTS_REPORT</stdReportType> <recentReportDocId>7be8eb66-cf1f-11e8-8f49-001e6796a8d7</recentReportDocId> <recentReportDocName><![CDATA[EPReport-1_Report_October_13_2018_12:19]]></recentReportDocName> <recentExecutionDurationInMillis>0</recentExecutionDurationInMillis> <recentExecutionDate>1539459476000</recentExecutionDate> </schedule> </schedules> </data> </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("dispatch", "getAllSchedules");
parameters.put("pageSize", "10");
parameters.put("currpage", "0");
String retStr = connection.invokeApi("reportService.do", parameters);
System.out.println(retStr);
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