omNovia Report Importer API Documentation

The omNovia Report Importer API is a webservice used to import information from omNovia events.

API Methods

getAttendees
getMeetings
getEvent
getEvents
getEventCount
getReport
getTranscripts
getTotals
getPolls
getPollResults
getQnAQuestionList
getQnAQuestionAnswers

General information and base sample code

In order to have access to the API, this need to be activated by the Sales department. The Sales department will activate the API usage for your company and provide you with the information needed to access the API.

companyId = 1234;          //Provided by omNovia Sales
companyPass = 'password';  //Provided by omNovia Sales

    

<html>
<head>
 <title>Report Import API Test</title>
</head>
<body>
 <h1>Report Import API Test</h1>
 <ul>
 <li><a href="/?action=getAttendees">getAttendees</a></li>
 <li><a href="/?action=getMeetings">getMeetings</a></li>
 <li><a href="/?action=getEvent">getEvent</a></li>
 <li><a href="/?action=getEvents">getEvents</a></li>
 <li><a href="/?action=getEventCount">getEventCount</a></li>
 <li><a href="/?action=getReport">getReport</a></li>
 <li><a href="/?action=getTotals">getTotals</a></li>
 <li><a href="/?action=getTranscripts">getTranscripts</a></li>
 <li><a href="/?action=getPolls">getPolls</a></li>
 <li><a href="/?action=getPollResults">getPollResults</a></li>
 <li><a href="/?action=getQnAQuestionList">getQnAQuestionList</a></li> 
 <li><a href="/?action=getQnAQuestionAnswers">getQnAQuestionAnswers</a></li>
 </ul>

<?php
$action = $_GET['action'];

switch($action)
{
    case "getAttendees":
        $res = getAttendees();
        break;

    case "getMeetings":
        $res = getMeetings();
        break;

    case "getEvent":
        $res = getEvent();
        break;
        
    case "getEvents":
        $res = getEvents();
        break;

    case "getEventCount":
        $res = getEventCount();
        break;

    case "getReport":
        $res = getReport();
        break;

    case "getTotals":
        $res = getTotals();
        break;
        
    case "getTranscripts":
        $res = getTranscripts();
        break;    

    case "getPolls":
        $res = getPolls();
        break;    

    case "getPollResults":
        $res = getPollResults();
        break;  
    
    case "getQnAQuestionsList":
         $res=getQnAQuestionsList();
         break; 

    case "getQnAQuestionAnswers":
         $res=getQnAQuestionAnswers();
         break; 
default:
 exit;
}

if ($res)
{
 list($method, $parameters, $url, $results) = $res;
 
 
 // "fix" xml by formatting
 if (false)
 {
 $dom = new DOMDocument();
 $dom->preserveWhiteSpace = false;
 $dom->loadHTML($results);
 $dom->formatOutput = true;
 $results = $dom->saveXML();
 }
 
 echo "Method: $method \n";
 echo "Parameters: ";
 print_r($parameters);
 echo "\n";
 echo "URL: $url\n";
 echo "Results: \n";
 echo "\n";
 echo htmlentities($results);
 echo "\n";  

}
?>
</body>
</html>

getAttendees()

This function will gather the information from the attendees that joined the event.

URL Call:
http://www.omnovia.com/support/apis/report_importer.php?action=getAttendees&companyId=[companyId]
&companyPass=[companyPass]&meetingId=[meetingId]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) meetingId

Sample Code:

function getAttendees()
{
    $array = array(
    'action'=>         'getAttendees',
    'companyId'=>      '1234',
    'companyPass'=>    'test',
    'meetingId'=>      '813606'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);
    
    return array("getAttendees()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
   <attendee>
      <attendanceNo>33808161</attendanceNo>
      <name>Joe Doe</name>
      <email>jdoe@demo.com</email>
      <role>0</role>
      <custom>companyCustomData</custom>
      <entryTime>2011-02-24 11:23:12</entryTime>
      <duration>18</duration>
      <ip>173.11.153.41</ip>
      <companyUsername>joedoe</companyUsername>
   </attendee>
   <attendee>
   <attendanceNo>33808162</attendanceNo>
   .
   .
   .
   <attendee>
      <attendanceNo>33808163</attendanceNo>
      <name>John Smith</name>
      <email>jsmith@demo.com</email>
      <phone>713-501-8206</phone>
      <role>3</role>
      <custom>othercustom</custom>
      <entryTime>2011-02-24 11:25:47</entryTime>
      <duration>16</duration>
      <ip>173.11.153.41</ip>
      <companyUsername>jsmith</companyUsername>
   </attendee>
</root>

getMeetings()

This function will provide you with the meeting information between two given dates.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getMeetings&companyId=[companyId]&companyPass=
[companyPass]&start=2011-09-01&end=2011-09-02&roomId=[roomId]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(str) start (yyyy-mm-dd)
(str) end (yyyy-mm-dd)
Optional:
(str) roomId

Sample Code:

function getMeetings()
{
    $array = array(
    'action'=>         'getMeetings',
    'companyId'=>      '1234',
    'companyPass'=>    'test',
    'start'=>          '2010-09-01',
    'end'=>            '2010-09-05'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getMeetings()", $array, $url, $xml);
}

Sample Output:


<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
   <meeting>
      <meetingId>14931122</meetingId>
      <startTime>2010-09-02 12:52:18</startTime>
   </meeting>
   <meeting>
      <meetingId>14932070</meetingId>
      <startTime>2010-09-02 16:16:41</startTime>
   </meeting>
   <meeting>
      <meetingId>14937108</meetingId>
      <startTime>2010-09-03 14:43:19</startTime>
   </meeting>
</root>

getEvent()

This function will return the attendee list with the name, email, registered and attended fields. Please use the Events API to obtain the eventId.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getEvent&companyId=[companyId]&companyPass=
[companyPass]&eventId=[eventId]&start=2011-09-01

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) eventId
(str) start (mm-dd-yyyy)

Sample Code:

function getEvent()
{
    $array = array(
    'action'=>         'getEvent',
    'companyId'=>      '1234',
    'companyPass'=>    'test',
    'start'=>          '2010-10-01',
    'eventId'=>        '65666'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);
    
    return array("getEvent()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
   <event>
      <attendee>
         <name>arara asdad</name>
         <email>asdas@omnovia.com</email>
         <registered>1</registered>
         <attended>0</attended>
      </attendee>
.
.
.
      <attendee>
         <name>Octavio ZXZ</name>
         <email>zcxas@omnovia.com</email>
         <registered>1</registered>
         <attended>1</attended>
      </attendee>
   </event>
</root>

getEvents()

This function will return the events between two given dates, this will give you the attendees that registered and if they attendeed or not the event..

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getEvents&companyId=[companyId]&companyPass=
[companyPass]&start=2011-09-01&end=2011-09-02

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(str) start (yyyy-mm-dd)
(str) end (yyyy-mm-dd)

Sample Code:

function getEvents()
{
    $array = array(
    'action'=>          'getEvents',
    'companyId'=>       '1234',
    'companyPass'=>     'test',
    'start'=>           '2010-10-01',
    'end'=>             '2010-12-01'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);
    
    return array("getEvents()", $array, $url, $xml);
}

Sample Output:

<root>
   <event>
      <name>Live event from Dallas</name>
      <id>55841</id>
      <eventid>20341254147031</eventid>
      <date>2010-10-12 09:00:00</date>
      <attendees>
         <attendee>
            <name>John Smith</name>
            <email>jsmth@demo.com</email>
            <registered>1</registered>
            <attended>0</attended>
         </attendee>
      </attendees>
   </event>
.
.
.
   <event>
      <name>Webinar</name>
      <id>69942</id>
      <eventid>52921288380818</eventid>
      <date>2010-10-29 14:45:00</date>
      <attendees>
         <attendee>
            <name>Austin T</name>
            <email>aTrex@demo.com</email>
            <registered>1</registered>
            <attended>0</attended>
         </attendee>
      </attendees>
   </event>
</root>

getEventCount()

This function will the return how many attendees registered for a given event.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getEventCount&companyId=[companyId]&companyPass=
[companyPass]&eventId=[eventId]&start=2011-09-01

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) eventId //from the event link http://test.omnovia.com/event/123456, its the "123456" number
(str) start (yyyy-mm-dd)

Sample Code:

function getEventCount()
{
    $array = array(
    'action'=>        'getEventCount',
    'companyId'=>     '1234',
    'companyPass'=>   'test',
    'eventID'=>       '73001285948346',
    'start'=>         '2010-10-01'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getEventCount()", $array, $url, $xml);
}

Sample Output:

<root>
   <eventID>74543</eventID>
   <registeredEventDate>2012-01-03 12:30:00</registeredEventDate>
   <count>2</count>
</root>

getReport()

This function return the event report.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getReport&companyId=[companyId]&companyPass=
[companyPass]&eventId=[eventId]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) eventId

Sample Code:

function getReport()
{
    $array = array(
    'action'=>         'getReport',
    'companyId'=>      '1234',
    'companyPass'=>    'test',
    'eventID'=>        '65666'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getReport()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
   <event>
      <registered><![CDATA[3]]></registered>
      <attended><![CDATA[2]]></attended>
      <ratio><![CDATA[67]]></ratio>
      <user>
         <id><![CDATA[10345088]]></id>
         <first_name><![CDATA[Octavio]]></first_name>
         <last_name><![CDATA[ZXZ]]></last_name>
         <email><![CDATA[zcxas@omnovia.com]]></email>
         <event_date><![CDATA[2011-02-24 11:30:00]]></event_date>
         <registration_date><![CDATA[2011-02-24 11:20AM]]></registration_date>
         <registered><![CDATA[1]]></registered>
         <attended><![CDATA[1]]></attended>
         <paid><![CDATA[0.00]]></paid>
         <answer20898><![CDATA[adsa]]></answer20898>
      </user>
      <user>
         <id><![CDATA[10345089]]></id>
         <first_name><![CDATA[luis]]></first_name>
         <last_name><![CDATA[asadsd]]></last_name>
         <email><![CDATA[luis@omnovia.com]]></email>
         <event_date><![CDATA[2011-02-24 11:30:00]]></event_date>
         <registration_date><![CDATA[2011-02-24 11:21AM]]></registration_date>
         <registered><![CDATA[1]]></registered>
         <attended><![CDATA[1]]></attended>
         <paid><![CDATA[0.00]]></paid>
         <answer20898><![CDATA[asdasd]]></answer20898>
      </user>
      <user>
         <id><![CDATA[10345090]]></id>
         <first_name><![CDATA[arara]]></first_name>
         <last_name><![CDATA[asdad]]></last_name>
         <email><![CDATA[asdas@omnovia.com]]></email>
         <event_date><![CDATA[2011-02-24 11:30:00]]></event_date>
         <registration_date><![CDATA[2011-02-24 11:21AM]]></registration_date>
         <registered><![CDATA[1]]></registered>
         <attended><![CDATA[0]]></attended>
         <paid><![CDATA[0.00]]></paid>
        <answer20898><![CDATA[asdas]]></answer20898>
      </user>
   </event>
</root>

getTotals()

This function will return the total number of registered people, the total number of people that attendeed the event and the ratio between registered people and attendees.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getTotals&companyId=[companyId]&companyPass=
[companyPass]&eventId=[eventId]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) eventId

Sample Code:

function getTotals()
{
    $array = array(
    'action'=>        'getTotals',
    'companyId'=>     '1234',
    'companyPass'=>   'test',
    'eventId'=>       '65666'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getTotals()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
<event>
   <registered><![CDATA[3]]></registered>
   <attended><![CDATA[2]]></attended>
   <ratio><![CDATA[67]]></ratio>
</event>
</root>

getTranscripts()

This function will return the event chat transcript.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getTranscripts&companyId=[companyId]
&companyPass=[companyPass]&meetingNos=[meetingtNos]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) meetingNos

Sample Code:

function getTranscripts()
{
    $array = array(
    'action'=>           'getTranscripts',
    'companyId'=>        '1234',
    'companyPass'=>      'test',
    'meetingNos'=>       '1100851,1100852',
    'getAudioLink'=>     'false'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getTranscripts()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
    <transcript>
        <meeting_no>14895451</meeting_no>
        <chats>
            <chat>
                <username>Bill Smith</username>
                <timestamp>16:25</timestamp>
                <message><![CDATA[number 12]]></message>
            </chat>
            <chat>
                <username>Jonh Doe </username>
                <timestamp>16:25</timestamp>
                <message><![CDATA[number 18]]></message>
            </chat>
        </chats>
    </transcript>
</root>

getPolls()

This function will return to you the polls displayed during an event.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getPolls&companyId=[companyId]&companyPass=
[companyPass]&meetingNo=[meetingNo]

Input Parameters:

GET Parameters:
Required:
(str) companyID
(str) companyPass
(num) meetingNo

Sample Code:

function getPolls()
{
    $array = array(
    'action'=>           'getPolls',
    'companyId'=>        '1234',
    'companyPass'=>      'test',
    'meetingNo'=>        '1106041',
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getPolls()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
   <poll>
      <id>8230</id>
      <questionID>1563</questionID>
      <name>First time user</name>
      <question><![CDATA[I am!]]></question>
      <roomID>1178</roomID>
      <time>2011-02-24 17:41:50</time>
      <authorName><![CDATA[Luis Dieguez]]></authorName>
      <multipleChoice>0</multipleChoice>
      <anonymous>0</anonymous>
      <shareResults>0</shareResults>
      <choice>
         <choiceID>5524</choiceID>
         <choiceBody><![CDATA[It is my first time]]></choiceBody>
         <order>0</order>
      </choice>
      <choice>
         <choiceID>5525</choiceID>
         <choiceBody><![CDATA[No, i have some previous experience]]></choiceBody>
         <order>1</order>
      </choice>
   </poll>

   <poll>
      <id>8231</id>
      <questionID>21949</questionID>
      <name>audio</name>
      <question><![CDATA[How is the audio]]></question>
      <roomID>1178</roomID>
      <time>2011-02-24 17:42:10</time>
      <authorName><![CDATA[Luis Dieguez]]></authorName>
      <multipleChoice>0</multipleChoice>
      <anonymous>0</anonymous>
      <shareResults>0</shareResults>
      <choice>
      <choiceID>81150</choiceID>
      <choiceBody><![CDATA[Loud]]></choiceBody>
      <order>0</order>
      </choice>
      <choice>
      <choiceID>81151</choiceID>
      <choiceBody><![CDATA[good]]></choiceBody>
      <order>1</order>
      </choice>
      <choice>
      <choiceID>81152</choiceID>
      <choiceBody><![CDATA[low]]></choiceBody>
      <order>2</order>
      </choice>
      <choice>
      <choiceID>81153</choiceID>
      <choiceBody><![CDATA[breaking]]></choiceBody>
      <order>3</order>
      </choice>
      </poll>
</root>

getPollResults()

This function will display the results from the instant polls runned during the event, using the function getPolls() you will get the poll ID.

URL Call:

http://www.omnovia.com/support/apis/report_importer.php?action=getPollResults&companyId=[companyId]
&companyPass=[companyPass]&resultID=[pollID]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(num) companyPass
(num) resultID             (This is the pollID returned from the getPolls() function above)

Sample Code:

function getPollResults()
{
$db = Mysql::instance();
    $array = array(
    'action'=>          'getPollResults',
    'companyId'=>       '1234',
    'companyPass'=>     'test',
    'resultID'=>        '20836',
    'voteDetails' =>    1
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);

    return array("getPollResults()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
    <result>
        <id>4900</id>
        <questionID>12297</questionID>
        <question><![CDATA[How is the audio quality?]]></question>
        <meetingNo>15327604</meetingNo>
        <time>2011-02-28 17:01:16</time>
        <authorName><![CDATA[omNovia Support]]></authorName>
        <multipleChoice>0</multipleChoice>
        <anonymous>0</anonymous>
        <shareResults>1</shareResults>
        <voterTotal>3</voterTotal>
        <choice>
            <choiceID>42382</choiceID>
            <choiceBody><![CDATA[Good]]></choiceBody>
            <choiceNo>1</choiceNo>
            <voteCount>2</voteCount>
        </choice>
        <choice>
            <choiceID>42383</choiceID>
            <choiceBody><![CDATA[Loud]]></choiceBody>
            <choiceNo>2</choiceNo>
            <voteCount>1</voteCount>
        </choice>
        <choice>
            <choiceID>42384</choiceID>
            <choiceBody><![CDATA[Low]]></choiceBody>
            <choiceNo>3</choiceNo>
            <voteCount>0</voteCount>
        </choice>
        <choice>
            <choiceID>42385</choiceID>
            <choiceBody><![CDATA[Breaking]]></choiceBody>
            <choiceNo>4</choiceNo>
            <voteCount>0</voteCount>
        </choice>
        <vote>
            <attendanceNo>20895756</attendanceNo>
            <voterName><![CDATA[luis dieguez]]></voterName>
            <voteChoiceNo>2</voteChoiceNo>
        </vote>
        <vote>
            <attendanceNo>20895757</attendanceNo>
            <voterName><![CDATA[omNovia Attendee]]></voterName>
            <voteChoiceNo>1</voteChoiceNo>
        </vote>
        <vote>
            <attendanceNo>20895755</attendanceNo>
            <voterName><![CDATA[omNovia Support]]></voterName>
            <voteChoiceNo>1</voteChoiceNo>
        </vote>
    </result>
</root>

getQnAQuestionsList()

This function will gather the questions participants asked during the QnA session.

URL Call:
http://www.omnovia.com/support/apis/report_importer.php?action=getQnAQuestionsList&companyId=[companyId]
&companyPass=[companyPass]&meetingNo=[meetingNo]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) meetingNo

Sample Code:

function getQnAQuestionsList()
{
    $array = array(
    'action'=>         'getQnAQuestionsList',
    'companyId'=>      '1234',
    'companyPass'=>    'test',
    'meetingNo'=>      '813606'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);
    
    return array("getQnAQuestionsList()", $array, $url, $xml);
}

Sample Output:

<?xml version ='1.0' encoding ='UTF-8' ?>
<root>
   <question>
     <id>138</id>
     <no>1</no>
     <timeIn>09:51 pm</timeIn>
     <question>q1</question>
     <priority>3</priority>
     <category>1</category>
     <status>1</status>
     <askerName>omNovia Eng4630</askerName>
     <askerEmail>support@omnovia.com</askerEmail>
   </question>
</root>

getQnAQuestionAnswers()

This function will gather the answers to the questions participants asked during the QnA session.

URL Call:
http://www.omnovia.com/support/apis/report_importer.php?action=getQnAQuestionAnswers&companyId=[companyId]
&companyPass=[companyPass]&meetingNo=[meetingNo]&qID=[questionID]

Input Parameters:

GET Parameters:
Required:
(str) companyId
(str) companyPass
(num) meetingNo
(num) qId - The number in the <id></id> tags obtained from getQnAQuestionsList function

Sample Code:

function getQnAQuestionAnswers()
{
    $array = array(
    'action'=>         'getQnAQuestionAnswers',
    'companyId'=>      '1234',
    'companyPass'=>    'test',
    'meetingNo'=>      '813606',
    'qId' =>           '789'
    );

    $url = 'http://omnovia.com/support/apis/report_importer.php?'.http_build_query($array);

    $xml = file_get_contents($url);
    
    return array("getQnAQuestionAnswers()", $array, $url, $xml);
}

Sample Output:

<root>
   <answer>
     <timeIn>05:31 pm</timeIn>
     <answer>yhry365</answer>
     <answererName>omNovia Eng236</answererName>
     <answererEmail>support@omnovia.com</answererEmail>
   </answer>
</root>