This API can be used to get the actual content of the generated report identified by the document ID.
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 | getReportAttachment |
reportDocumentId | e.g. 34ad199e-d96c-11e8-8f49-001e6796a8d7 |
xml | true |
pageSize | Number of items in a page, default value is 10. |
currPage | page number to fetch, must be specified for 2nd page onwards. Value of currPage starts with 0. So for page 2 specify currPage = 1 |
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
CSV Response without xml paramter
sep=,
"Username","First Name","Last Name","Email","Phone","Referrer","Created Date","Last Access","Groups",Enrolled Courses,Completed Courses,Enrolled Programs,Completed Programs,Credits Earned,"Gender","Age","Buddy","mentor","AprilWeek4Prop","ABC","DateofBirth","July20","Aug12","address","Oct13"
"sep-15","Sep-15-update","Sep-15","Sep15@edubrite.com","","","09/16/2018 00:00 PDT","09/16/2018 00:00 PDT","Training",5,5,1,1,0.0,"Male","","qwewqe","","wewrw","","01/16/2013","qweqwe","werwr","",""
"sep16-2","Sep16-2","Sep16-2","Sep16-2@edubrite.com","","","09/16/2018 00:12 PDT","","Training",,,,,,"","","","","","","","","","",""
"sep16-3","Sep16-3","Sep16-3","Sep16-3@edubrite.com","","","09/16/2018 00:14 PDT","","Training",,,,,,"","","","","","","","","","",""
"sep16-4","Sep16-4","Sep16-4","Sep16-4@edubrite.com","","","09/16/2018 00:14 PDT","","Training",,,,,,"","","","","","","","","","",""
"sep9-user1","Sep9-user1","Sep9-user1","Sep9-user1@edubrite.com","112112123","","09/09/2018 19:32 PDT","09/10/2018 00:00 PDT","Training",5,4,1,1,3.0,"","","","","","","09/11/2018","asdsadfs","","",""
XML Reponse for xml parameter
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> <content id="34ad199e-d96c-11e8-8f49-001e6796a8d7" numItems="5" numOfPages="1" currPage="0" pageSize="100"> <name><![CDATA[LastMonthUserReport_Report_October_26_2018_14:29]]></name> <record> <Username><![CDATA[sep-15]]></Username> <FirstName><![CDATA[Sep-15-update]]></FirstName> <LastName><![CDATA[Sep-15]]></LastName> <Email><![CDATA[Sep15@edubrite.com]]></Email> <Phone /> <Referrer /> <CreatedDate><![CDATA[09/16/2018 00:00 PDT]]></CreatedDate> <LastAccess><![CDATA[09/16/2018 00:00 PDT]]></LastAccess> <Groups><![CDATA[Training]]></Groups> <EnrolledCourses><![CDATA[5]]></EnrolledCourses> <CompletedCourses><![CDATA[5]]></CompletedCourses> <EnrolledPrograms><![CDATA[1]]></EnrolledPrograms> <CompletedPrograms><![CDATA[1]]></CompletedPrograms> <CreditsEarned><![CDATA[0.0]]></CreditsEarned> <Gender><![CDATA[Male]]></Gender> <Age /> <Buddy><![CDATA[qwewqe]]></Buddy> <mentor /> <AprilWeek4Prop><![CDATA[wewrw]]></AprilWeek4Prop> <ABC /> <DateofBirth><![CDATA[01/16/2013]]></DateofBirth> <July20><![CDATA[qweqwe]]></July20> <Aug12><![CDATA[werwr]]></Aug12> <address /> <Oct13 /> </record> <record> <Username><![CDATA[sep16-2]]></Username> <FirstName><![CDATA[Sep16-2]]></FirstName> <LastName><![CDATA[Sep16-2]]></LastName> <Email><![CDATA[Sep16-2@edubrite.com]]></Email> <Phone /> <Referrer /> <CreatedDate><![CDATA[09/16/2018 00:12 PDT]]></CreatedDate> <LastAccess /> <Groups><![CDATA[Training]]></Groups> <EnrolledCourses /> <CompletedCourses /> <EnrolledPrograms /> <CompletedPrograms /> <CreditsEarned /> <Gender /> <Age /> <Buddy /> <mentor /> <AprilWeek4Prop /> <ABC /> <DateofBirth /> <July20 /> <Aug12 /> <address /> <Oct13 /> </record> <record> <Username><![CDATA[sep16-3]]></Username> <FirstName><![CDATA[Sep16-3]]></FirstName> <LastName><![CDATA[Sep16-3]]></LastName> <Email><![CDATA[Sep16-3@edubrite.com]]></Email> <Phone /> <Referrer /> <CreatedDate><![CDATA[09/16/2018 00:14 PDT]]></CreatedDate> <LastAccess /> <Groups><![CDATA[Training]]></Groups> <EnrolledCourses /> <CompletedCourses /> <EnrolledPrograms /> <CompletedPrograms /> <CreditsEarned /> <Gender /> <Age /> <Buddy /> <mentor /> <AprilWeek4Prop /> <ABC /> <DateofBirth /> <July20 /> <Aug12 /> <address /> <Oct13 /> </record> <record> <Username><![CDATA[sep16-4]]></Username> <FirstName><![CDATA[Sep16-4]]></FirstName> <LastName><![CDATA[Sep16-4]]></LastName> <Email><![CDATA[Sep16-4@edubrite.com]]></Email> <Phone /> <Referrer /> <CreatedDate><![CDATA[09/16/2018 00:14 PDT]]></CreatedDate> <LastAccess /> <Groups><![CDATA[Training]]></Groups> <EnrolledCourses /> <CompletedCourses /> <EnrolledPrograms /> <CompletedPrograms /> <CreditsEarned /> <Gender /> <Age /> <Buddy /> <mentor /> <AprilWeek4Prop /> <ABC /> <DateofBirth /> <July20 /> <Aug12 /> <address /> <Oct13 /> </record> <record> <Username><![CDATA[sep9-user1]]></Username> <FirstName><![CDATA[Sep9-user1]]></FirstName> <LastName><![CDATA[Sep9-user1]]></LastName> <Email><![CDATA[Sep9-user1@edubrite.com]]></Email> <Phone><![CDATA[112112123]]></Phone> <Referrer /> <CreatedDate><![CDATA[09/09/2018 19:32 PDT]]></CreatedDate> <LastAccess><![CDATA[09/10/2018 00:00 PDT]]></LastAccess> <Groups><![CDATA[Training]]></Groups> <EnrolledCourses><![CDATA[5]]></EnrolledCourses> <CompletedCourses><![CDATA[4]]></CompletedCourses> <EnrolledPrograms><![CDATA[1]]></EnrolledPrograms> <CompletedPrograms><![CDATA[1]]></CompletedPrograms> <CreditsEarned><![CDATA[3.0]]></CreditsEarned> <Gender /> <Age /> <Buddy /> <mentor /> <AprilWeek4Prop /> <ABC /> <DateofBirth><![CDATA[09/11/2018]]></DateofBirth> <July20><![CDATA[asdsadfs]]></July20> <Aug12 /> <address /> <Oct13 /> </record> </content> </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 To Get CSV Response
/* Check API Call for detail generic code */
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("dispatch", "getReportAttachment");
parameters.put("reportDocumentId", "34ad199e-d96c-11e8-8f49-001e6796a8d7");
String retStr = connection.invokeApi("reportService.do", parameters);
System.out.println(retStr);
Code Snippet To Get XML Response
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("dispatch", "getReportAttachment");
parameters.put("reportDocumentId", "34ad199e-d96c-11e8-8f49-001e6796a8d7");
parameters.put("xml", "true");
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