omNovia Archives 

To enable the API, please contact omNovia Sales department. They will provide you with the company information.

API Methods

General Information
Company Info
Archives List
Archive Details
Insert Registrant with Credit Card Payment
Record Movie Access
Verify is there is a payment for an archive

General information and base sample code

The following code block is provided as a function to initiate the authentication and make the url call. Each sample method utilizes this function.

$companyID = 1234;          //Provided by omNovia Sales
$roomID = 5678;             //Provided by omNovia Sales
$md5Pass = md5('password'); //Provided by omNovia Sales

$eventServiceURL = "http://www.omnovia.com/api/event";

function callRemote($url, $params, $returnResponse = true)
{
    $c = curl_init($url);

    curl_setopt($c, CURLOPT_POST, true);
    curl_setopt($c, CURLOPT_POSTFIELDS, http_build_query($params));
    curl_setopt($c, CURLOPT_HEADER, false);
    curl_setopt($c, CURLOPT_RETURNTRANSFER, $returnResponse);

    $response = curl_exec($c);
    curl_close($c);
    
    if ($returnResponse)
        return $response;
}

Company Info

This method returns all the properties and settings for a specified company.

URL Call: 
http://www.omnovia.com/api/event/company
Input Parameters: 
POST Parameters:
Required:
(str) companyID
(str) md5Pass
Sample Code: 
function companyInfo()
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass
    );

    $url = $eventServiceURL . "/company";

    echo callRemote($url, $params);
}

companyInfo();
Sample Output: 
<company>
    <companyID><![CDATA[1234]]></companyID>
    <name><![CDATA[ABCD]]></name>
    <location><![CDATA[Houston,TX,US]]></location>
    <language><![CDATA[EN]]></language>
    <website><![CDATA[http://www.abcd.com]]></website>
    <shorturl><![CDATA[abcd]]></shorturl>
    <eventPeriod><![CDATA[60]]></eventPeriod>
    <defaultPub><![CDATA[1]]></defaultPub>
    <announcement><![CDATA[Welcome to the ABCD  Conference Center]]></announcement>
    <loginURL><![CDATA[http://www.abcdge.com/members]]></loginURL>
    <logo2><![CDATA[0]]></logo2>
    <showArchiveLink><![CDATA[1]]></showArchiveLink>
    <paymentsEnabled><![CDATA[2]]></paymentsEnabled>
    <currentDate><![CDATA[2010-05-03]]></currentDate>
    <room>
        <roomID><![CDATA[5678]]></roomID>
        <name><![CDATA[room1]]></name>
        <timeZoneName><![CDATA[US/Central]]></timeZoneName>
    </room>
    <category>
        <id><![CDATA[810]]></id>
        <name><![CDATA[Marketing]]></name>
    </category>
    <category>
        <id><![CDATA[808]]></id>
        <name><![CDATA[Sales]]></name>
    </category>
    <category>
        <id><![CDATA[809]]></id>
        <name><![CDATA[Training]]></name>
    </category>
    <preferences>
        <callbackURL><![CDATA[http://www.abcd.com/notifyme.php]]></callbackURL>
        <groupRegistrationEnabled><![CDATA[1]]></groupRegistrationEnabled>
    </preferences>
    <paypalinfo>
        <apiUsername><![CDATA[aaaaaaaaaa]]></apiUsername>
        <apiPassword><![CDATA[bbbbbbbbbb]]></apiPassword>
        <signature><![CDATA[cccccccccc]]></signature>
    <currency><![CDATA[USD]]></currency>
    <contact><![CDATA[info@abcd.com]]></contact>
    <environment><![CDATA[sandbox]]></environment>
    </paypalinfo>
    <promotionCode>
        <id><![CDATA[1]]></id>
            <discountAmount><![CDATA[10.00]]></discountAmount>
            <discountRate><![CDATA[0.00]]></discountRate>
            <code><![CDATA[10Off]]></code>
        </promotionCode>
        <promotionCode>
            <id><![CDATA[3]]></id>
            <discountAmount><![CDATA[0.00]]></discountAmount>
            <discountRate><![CDATA[100.00]]></discountRate>
            <code><![CDATA[100PercentOff]]></code>
        </promotionCode>
</company>

Archives List

This method will retrieve the event list.

URL Call: 
http://www.omnovia.com/api/archive/getList/{nMonths}
Input Parameters: 
POST Parameters:
Required:
(str) companyID
(str) md5Pass
(num) eventPeriod
Sample Code: 
function archivesList($eventPeriod = 0)
{
 global $companyID, $md5Pass, $archiveServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass
 );

 $url = $archiveServiceURL . "/getList/$eventPeriod";

 echo callRemote($url, $params);
}
archivesList(6);
Sample Output: 
<movie>
   <movieID><![CDATA[61239]]></movieID>
      <roomID><![CDATA[1977]]></roomID>
      <title><![CDATA[TheStig]]></title>
      <fileType><![CDATA[REC]]></fileType>
      <movieLength><![CDATA[183]]></movieLength>
      <movieWidth><![CDATA[0]]></movieWidth>
      <movieHeight><![CDATA[0]]></movieHeight>
      <omnoviaHosted><![CDATA[1]]></omnoviaHosted>
      <dateAdded><![CDATA[2010-10-28]]></dateAdded>
      <level><![CDATA[1]]></level>
      <eventID><![CDATA[53292]]></eventID>
      <published><![CDATA[1]]></published>
      <authorUID><![CDATA[18828]]></authorUID>
      <protection><![CDATA[0]]></protection>
      <version><![CDATA[2]]></version>
      <protocol><![CDATA[http]]></protocol>
      <date><![CDATA[2010-10-28]]></date>
      <presenter><![CDATA[Chuck Norris]]></presenter>
      <roomName><![CDATA[room1]]></roomName>
      <timeZoneName><![CDATA[US/Central]]></timeZoneName>
      <clientsOnly><![CDATA[0]]></clientsOnly>
      <price><![CDATA[0.00]]></price>
      <priceMember><![CDATA[0.00]]></priceMember>
   </movie>
   <movie>
      <movieID><![CDATA[39759]]></movieID>
.
.
.

Archives Details

This method retrieve the archive details using the archive ID {movieID}.

URL Call: 
http://www.omnovia.com/api/archive/getMovie/ {movieID}
Input Parameters: 
POST Parameters:
Required:
(str) companyID
(str) md5Pass
(str) movieID
Sample Code: 
function archiveDetails($movieID)
{
 global $companyID, $md5Pass, $archiveServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass
 );

 $url = $archiveServiceURL . "/getMovie/" . $movieID;

 echo callRemote($url, $params);
}
archiveDetails(39350);
Sample Output:
<movie>
<movieID><![CDATA[39350]]></movieID>
<roomID><![CDATA[1977]]></roomID>
<title><![CDATA[TheStig]]></title>
<fileType><![CDATA[REC]]></fileType>
<movieLength><![CDATA[183]]></movieLength>
<movieWidth><![CDATA[0]]></movieWidth>
<movieHeight><![CDATA[0]]></movieHeight>
<omnoviaHosted><![CDATA[1]]></omnoviaHosted>
<dateAdded><![CDATA[2010-10-28]]></dateAdded>
<level><![CDATA[1]]></level>
<eventID><![CDATA[53292]]></eventID>
<published><![CDATA[1]]></published>
<authorUID><![CDATA[18828]]></authorUID>
<protection><![CDATA[0]]></protection>
<version><![CDATA[2]]></version>
<protocol><![CDATA[http]]></protocol>
<date><![CDATA[2010-10-28]]></date>
<presenter><![CDATA[Chuck Norris]]></presenter>
<roomName><![CDATA[room1]]></roomName>
<timeZoneName><![CDATA[US/Central]]></timeZoneName>
<clientsOnly><![CDATA[0]]></clientsOnly>
<price><![CDATA[0.00]]></price>
<priceMember><![CDATA[0.00]]></priceMember>
</movie>

Insert Registrant with Credit Card payment

This method allows you to take a payment to allow the archive to be watched. The company must be setup to accept credit card payments for archives. Contact our sales department to activate the credit card module.

URL Call: 
http://www.omnovia.com/api/archive/archivepayment
Input Parameters: 
POST Parameters:
Required:
(str) companyID
(str) md5Pas
(int) movieID
(str) email
(str) firstName 
(str) lastName
(str) ccFirstName 
(str) ccLastName 
(str) ccType  ('Visa', MasterCard', 'Discover', 'American Express')
(str) ccNumber (valid credit card number)
(int) ccExpDateMonth 
(int) ccExpDateYear
(int) ccCVV2Number 
(str) ccAddress1
(str) ccCity 
(str) ccState 
(int) ccZip
(str) ccCountry
(float) amountToPay
Optional parameters:

(str)   custom (str)
(float) totalTax (float)
(str 127) invoiceNumber
(str 256) CC_Custom
(str) CC_UserName 
(str) CC_Password 
(str) CC_Signature

Sample Code: 
function insertArchivePayment($movieID)
{
 global $companyID, $md5Pass, $archiveServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass,
 'movieID' => $movieID,
 'email' => 'joe@martin.com',
 'firstName' => 'Joe',
 'lastName' => 'Martin',    
 'ccFirstName' => 'Joe',
 'ccLastName' => 'Martin',
 'ccType' => 'Visa',
 'ccNumber' => '4245350606097927',
 'ccExpDateMonth'=> 12,
 'ccExpDateYear' => 2019,
 'ccCVV2Number' => 135,
 'ccAddress1' => '1 Main St',
 'ccCity' => 'San Jose',
 'ccState' => 'CA',
 'ccZip' => '95131',
 'ccCountry' => 'US',
 'amountToPay' => 10.00,
 
 'totalTax' => 0.83,
 'invoiceNumber' => 'inv' . rand(1, 9999),
 'CC_Custom' => "$movieID|PPT Recast",    
 
//    'CC_UserName' => 'AAAAA',
//    'CC_Password' => 'BBBBB',
//    'CC_Signature' => 'CCCCC',

 'dummy' => 0
 );

 $url = $archiveServiceURL . "/archivepayment";

 echo callRemote($url, $params);
}
insertArchivePayment(39350);
Sample Output: 
<status>
   <movieID><![CDATA[39350]]></movieID>
   <paymentID><![CDATA[3]]></paymentID>
   <TYPE><![CDATA[Payment]]></TYPE> 
   <TIMESTAMP><![CDATA[2010-11-22T22:16:47Z]]></TIMESTAMP>
   <CORRELATIONID><![CDATA[1c58f5154fdd5]]></CORRELATIONID>
   <ACK><![CDATA[Success]]></ACK>
   <AMT><![CDATA[10.00]]></AMT>
   <CURRENCYCODE><![CDATA[USD]]></CURRENCYCODE>
   <AVSCODE><![CDATA[X]]></AVSCODE>
   <CVVMATCH><![CDATA[M]]></CVVMATCH>
   <TRANSACTIONID><![CDATA[98T64206M19665523]]></TRANSACTIONID>
   <failure_contact><![CDATA[joe@martin.com]}></failure_contact>
</status>

Record Movie Access

This method is used for reporting; it will record Movie access.

URL Call: 
http://www.omnovia.com/api/archive/recordMovieAccess
Input Parameters: 
POST Parameters:
Required:
(str) companyID
(str) md5Pass
(int)movieID
Optional parameters:
roomID (int)
firstName (str)
lastName (str)
email (str)
phone (str)
address (str)
city (str)
state (str)
zip (str)
country (str)
custom (str)
paymentID (int)

Sample Code: 
function recordMovieAccess($movieID, $roomID, $paymentID = 0)
{
 global $companyID, $md5Pass, $archiveServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass,
 'movieID' => $movieID,
 'roomID' => $roomID,
 'firstName' => 'Paul',
 'lastName' => 'Marmolejo',    
 'email' => 'pmarmolejo@omnovia.com',
 'phone' => '713-123-4567',
 'address' => '1 Main St',
 'city' => 'Houston',
 'state' => 'TX',
 'zip' => '77001',
 'country' => 'USA',
 'custom' => '',
 'paymentID' => $paymentID
 );

 $url = $archiveServiceURL . "/recordMovieAccess";

 echo callRemote($url, $params);
}
recordMovieAccess(39350, $roomID, 1);
Sample Output: 
Access Number:
<root>362139</root>

Verify if there is a payment for an archive

 

URL Call: 
http://www.omnovia.com/api/archive/checkpayment
Input Parameters: 
POST Parameters:
Required:
(str) companyID
(str) md5Pass
(int) movieID
(str) email
Sample Code: 
function checkArchivePayment($movieID, $email)
{
 global $companyID, $md5Pass, $archiveServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass,
 'movieID' => $movieID,
 'email' => $email
 );

 $url = $archiveServiceURL . "/checkpayment";

 echo callRemote($url, $params);
}
checkArchivePayment(39350, "info@company.com");
Sample Output: 
<payment>
  <id><![CDATA[1]]></id>
</payment>