{

omNovia Event API Documentation

The omNovia Event API is a webservice used to create, modify, and delete your events.

API Methods

General Information and base sample code
Create and Update Event
Delete Event
Event List
Event Details
Event Details By Public ID
Event Report
Event List by Days
Event Registration
Get custom questions
DEPRECATEDInsert Registrant
DEPRECATEDInsert Registrant with Credit Card Payment
Manual Send Email
Promotion Info
Refund Payment
Company Info

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 support
$roomID = 5678;             //Provided by omNovia support
$md5Pass = md5('password'); //Provided by omNovia support

$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;
}

Create and Update Event

Events can be created and updated with this API call. If you pass an eventID, that event is updated. If you do not pass an eventID, a new event is created. Please see the examples below in the sample code section.

URL Call:

http://www.omnovia.com/api/event/save

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(array) $params - contains all the relevant data such as event name, description, recurring event, etc. 
(num) eventID - Required only if editing an existing event; for new events, evenID will be empty.
(str) start_date (mm/dd/yyyy)

Sample Code:

function saveEvent($eventID, $roomID) //If eventID is empty = New event
{
    global $companyID, $md5Pass, $eventServiceURL;

    $params = array(
    'eventID' => $eventID,
    'companyID' => $companyID,
    'md5pass' => $md5Pass,
    'event_name' => 'New Event',
    'description' => 'Event created from API',                     
    'roomID' => $roomID,
    'start_date' => '05/10/2010',
    'times_of_event' => '14:00',
    'recurring' => 'N',                               // N Never, D Daily, W Weekly, B Bi-weekly 
    'category' => 810,
    'allowRegisterAll' => 0,                          // Boolean
    'allowedToEnter' => 15,
    'untilToEnter' => 60,
    'notifyOnRegister' => 0,                          // Boolean
    'charSet' => 'UTF-8',
    'reg_subject' => 'Thank you for registering for our event',
    'reg_text_text' => 'Thank you for registering for our event',
    'reminder1_int' => 1,
    'price' => 10.00
    );

    $url = $eventServiceURL . "/save";

    echo callRemote($url, $params);
}


// Use only one of the two following lines:
saveEvent("", $roomID);       // First parameter is empty, so this will CREATE a new event.
saveEvent(12345, $roomID);    // First parameter is an eventID, so this will UPDATE that event.

Sample Output:

<status>
    <save><![CDATA[completed]]></save>
    <id><![CDATA[12345]]></id>
    <pid><![CDATA[81431272927056]]></pid>
</status>

Delete Event

This method allows you to delete an event.

URL Call:

http://www.omnovia.com/api/event/delete/{eventID}

Input Parameters:

URL Parameters:
Required:
(num) eventID: Internal Event ID. This is not the public Event ID associated with the registration URL.
The eventID can be retrieved from the Event List function.
POST Parameters:
Required:
(str) companyID
(str) md5Pass

Sample Code:

function deleteEvent($eventID)
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass
    );

    $url = $eventServiceURL . "/delete/" . $eventID;

    echo callRemote($url, $params);
}

deleteEvent(12345);

Sample Output:

<status>
    <delete><![CDATA[completed]]></delete>
</status>

Event List

This method returns all of the events (expired, current, and recurring) created for a specified company.

URL Call:

http://www.omnovia.com/api/event/list

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass

Sample Code:

function eventsList()
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass
    );

    $url = $eventServiceURL . "/list";

    echo callRemote($url, $params);
}

eventsList();

Sample Output:

<event>
  <eventID><![CDATA[12345]]></eventID>
  <p_eventID><![CDATA[81431272927056]]></p_eventID>
  <roomID><![CDATA[5678]]></roomID>
  <creator><![CDATA[0]]></creator>
  <date><![CDATA[2010-02-19]]></date>
  <time><![CDATA[09:00]]></time>
  <utime><![CDATA[1266570000]]></utime>
  <startdate_of_event><![CDATA[2010-02-19]]></startdate_of_event>
  <times_of_event><![CDATA[9:00]]></times_of_event>
  <eventActive2><![CDATA[1]]></eventActive2>
  <event_name><![CDATA[Example Event]]></event_name>
  <description><![CDATA[Example Event]]></description>
  <allowedToEnter><![CDATA[30]]></allowedToEnter>
  <untilToEnter><![CDATA[45]]></untilToEnter>
  <reminder1Date><![CDATA[0000-00-00]]></reminder1Date>
  <reminder2Date><![CDATA[0000-00-00]]></reminder2Date>
  <reminder1Days><![CDATA[1]]></reminder1Days>
  <reminder2Days><![CDATA[0]]></reminder2Days>
  <reminder2Hours><![CDATA[0]]></reminder2Hours>
  <accesslevel><![CDATA[20]]></accesslevel>
  <recurring><![CDATA[N]]></recurring>
  <charSet><![CDATA[UTF-8]]></charSet>
  <allowRegisterAll><![CDATA[0]]></allowRegisterAll>
  <category_id><![CDATA[0]]></category_id>
  <notifyOnRegister><![CDATA[0]]></notifyOnRegister>
  <endDate><![CDATA[0000-00-00]]></endDate>
  <recastID><![CDATA[0]]></recastID>
  <future><![CDATA[1]]></future>
  <roomname><![CDATA[room1]]></roomname>
  <price><![CDATA[10.00]]></price>
  <priceMember><![CDATA[5.00]]></priceMember>    
</event>
<event>
</event>
.
.
.

Event List by Days

This method returns a list of events from the current date to the specified number of days in the future. You can also filter by category by passing the optional parameter categoryID.

URL Call:

http://www.omnovia.com/api/event/listbydays/{nDays}/{categoryID}

Input Parameters:

URL Parameters:
Required:
(num) nDays - The number of days to show (example:  60 = Sixty days in the future)
Optional:
(num) categoryID - Event Category ID

POST Parameters:
Required:
(str) companyID
(str) md5Pass

Sample Code:

function eventsListByDays($nDays = 60, $categoryID = "")
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass
    );

    $url = $eventServiceURL . "/listbydays/$nDays/$categoryID";

    echo callRemote($url, $params);
}

eventsListByDays(60);       // Returns a list of events from the current day until the next 60 days.
eventsListByDays(60, 808);  // Returns a list of events from the current day until the next 60 days for category 808.

Sample Output:

nDays: the number of days to show (example: 1 = one day in the future)
categoryID: event categoryID

Example of XML result:
<event>
  <eventID><![CDATA[12345]]></eventID>
  <p_eventID><![CDATA[81431272927056]]></p_eventID>
  <accesslevel><![CDATA[20]]></accesslevel>
  <roomID><![CDATA[5678]]></roomID>
  <creator><![CDATA[0]]></creator>
  <event_name><![CDATA[Example Event]]></event_name>
  <description><![CDATA[Example Event]]></description>
  <date><![CDATA[2010-02-19]]></date>
  <time><![CDATA[09:00:00]]></time>
  <recurring><![CDATA[N]]></recurring>
  <allowedToEnter><![CDATA[30]]></allowedToEnter>
  <untilToEnter><![CDATA[45]]></untilToEnter>
  <endDate><![CDATA[0000-00-00]]></endDate>
  <clientsOnly><![CDATA[1]]></clientsOnly>
  <category_id><![CDATA[0]]></category_id>
  <hasImage><![CDATA[0]]></hasImage>
  <timeZoneName><![CDATA[US/Central]]></timeZoneName>
  <checked><![CDATA[0]]></checked>
  <price><![CDATA[10.00]]></price>
  <priceMember><![CDATA[5.00]]></priceMember>    
</event>
<event>
</event>
.
.
.

Event Details

This method lists all the properties and settings for a specified event.

URL Call:

http://www.omnovia.com/api/event/detail/{eventID}

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass

Sample Code:

function eventDetails($eventID)
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass
    );

    $url = $eventServiceURL . "/detail/" . $eventID;

    echo callRemote($url, $params);
}

eventDetails(12345);

Sample Output:

<event>
    <future><![CDATA[0]]></future>
    <eventID><![CDATA[12345]]></eventID>
    <p_eventID><![CDATA[12345678901234]]></p_eventID>
    <roomID><![CDATA[5678]]></roomID>
    <notifyOnRegister><![CDATA[0]]></notifyOnRegister>
    <creator><![CDATA[0]]></creator>
    <date><![CDATA[03/29/2010]]></date>
    <time><![CDATA[09:15:00]]></time>
    <startdate_of_event><![CDATA[03/29/2010]]></startdate_of_event>
    <times_of_event><![CDATA[9:15]]></times_of_event>
    <eventActive2><![CDATA[1]]></eventActive2>
    <event_name><![CDATA[Regular Event]]></event_name>
    <description><![CDATA[This is an example of a regular event]]></description>
    <clientsOnly><![CDATA[1]]></clientsOnly>
    <allowedToEnter><![CDATA[30]]></allowedToEnter>
    <untilToEnter><![CDATA[45]]></untilToEnter>
    <reminder1Date><![CDATA[0000-00-00]]></reminder1Date>
    <reminder2Date><![CDATA[0000-00-00]]></reminder2Date>
    <reminder1Days><![CDATA[1]]></reminder1Days>
    <reminder2Days><![CDATA[0]]></reminder2Days>
    <reminder2Hours><![CDATA[0]]></reminder2Hours>
    <tweetHours><![CDATA[0]]></tweetHours>
    <accesslevel><![CDATA[20]]></accesslevel>
    <recurring><![CDATA[N]]></recurring>
    <charSet><![CDATA[UTF-8]]></charSet>
    <allowRegisterAll><![CDATA[0]]></allowRegisterAll>
    <category_id><![CDATA[810]]></category_id>
    <endDate><![CDATA[00/00/0000]]></endDate>
    <showLoginInfo><![CDATA[1]]></showLoginInfo>
    <recastID><![CDATA[0]]></recastID>
    <price><![CDATA[0.00]]></price>
    <priceMember><![CDATA[0.00]]></priceMember>
    <timeZoneName><![CDATA[US/Central]]></timeZoneName>
    <hasImage><![CDATA[1]]></hasImage>
    <expired><![CDATA[0]]></expired>
    <question>
        <questionID><![CDATA[19471]]></questionID>
        <eventID><![CDATA[0]]></eventID>
        <companyID><![CDATA[1843]]></companyID>
        <question><![CDATA[Telephone number]]></question>
        <questionType><![CDATA[1]]></questionType>
        <displayOrder><![CDATA[1]]></displayOrder>
        <required><![CDATA[1]]></required>
    </question>
</event>

Event Details by Public ID

This method lists all the properties and settings for a specified event using the public ID of the event.

URL Call:

http://www.omnovia.com/api/event/info/{p_eventID}

Input Parameters:

URL Parameters:
Required:
(num) p_eventID: Public ID of the event - This is the long number at the end of the event link.

POST Parameters:
Required:
(str) companyID
(str) md5Pass

Sample Code:

function eventDetailsByPublicID($pEventID)
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass,
    );

    $url = $eventServiceURL . "/info/$pEventID";

    echo callRemote($url, $params);
}

eventDetailsByPublicID("81431272927056");

Sample Output:

<event>
    <eventID><![CDATA[67890]]></eventID>
    <p_eventID><![CDATA[81431272927056]]></p_eventID>
    <roomID><![CDATA[5678]]></roomID>
    <creator><![CDATA[0]]></creator>
    <date><![CDATA[2010-05-08]]></date>
    <time><![CDATA[09:00:00]]></time>
    <startdate_of_event><![CDATA[2010-05-08]]></startdate_of_event>
    <times_of_event><![CDATA[9:00]]></times_of_event>
    <eventActive2><![CDATA[1]]></eventActive2>
    <event_name><![CDATA[Test event]]></event_name>
    <description><![CDATA[This is a test event]]></description>
    <allowedToEnter><![CDATA[30]]></allowedToEnter>
    <untilToEnter><![CDATA[45]]></untilToEnter>
    <reminder1Date><![CDATA[0000-00-00]]></reminder1Date>
    <reminder2Date><![CDATA[0000-00-00]]></reminder2Date>
    <reminder1Days><![CDATA[1]]></reminder1Days>
    <reminder2Days><![CDATA[0]]></reminder2Days>
    <reminder2Hours><![CDATA[0]]></reminder2Hours>
    <tweetHours><![CDATA[0]]></tweetHours>
    <accesslevel><![CDATA[20]]></accesslevel>
    <recurring><![CDATA[N]]></recurring>
    <charSet><![CDATA[UTF-8]]></charSet>
    <allowRegisterAll><![CDATA[0]]></allowRegisterAll>
    <category_id><![CDATA[0]]></category_id>
    <notifyOnRegister><![CDATA[0]]></notifyOnRegister>
    <endDate><![CDATA[0000-00-00]]></endDate>
    <clientsOnly><![CDATA[1]]></clientsOnly>
    <recastID><![CDATA[0]]></recastID>
    <showLoginInfo><![CDATA[1]]></showLoginInfo>
</event>

Event Report

This method returns a report of each invitee that has registered for a specified event. The report can be returned in xml format or as a .csv file.

URL Call:

http://www.omnovia.com/api/event/report/{eventID} -  Internal Event ID. This is not the public Event ID 
associated with the registration URL.
The eventID can be retrieved from the Event List function.

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass

Sample Code:

function eventReport($eventID)
{
 global $companyID, $md5Pass, $eventServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass
 );

 $url = $eventServiceURL . "/report/" . $eventID;

 echo callRemote($url, $params);
}

eventReport(12345);

Sample Output:

<event>
    <registered><![CDATA[1]]></registered>
    <user>
        <id><![CDATA[8704619]]></id>
        <first_name><![CDATA[Joe]]></first_name>
        <last_name><![CDATA[Martin]]></last_name>
        <email><![CDATA[joe@martin.com]]></email>
        <event_date><![CDATA[2010-01-08 09:00:00]]></event_date>
        <registration_date><![CDATA[2010-01-18 17:20:04]]></registration_date>
        <registered><![CDATA[1]]></registered>
        <attended><![CDATA[0]]></attended>
        <paid><![CDATA[10.00]]></paid>
    </user>
    <user>
    .
    .
    .
    </user>
    .
    .
    .    
</event>

Event Registration

Use this function to register one or more participants to one or more events. You can also add the answers to the custom questions added in the event manager and make credit card payments. Please note you will need to use the getCustomQuestions function to retrieve the event or company custom questions.

URL Call:

http://www.omnovia.com/api/event/save

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(num) eventID - Part of $event_info, a varialble in xml format.
(str) start_date (mm/dd/yyyy) - Part of $even_info, a variable in xml format.
(str) $registrant_info - All relevant data of registrant(s) in xml format.

Sample Code:

function eventRegistration($eventID, $eventDate, $eventTime)
{
  global $companyID, $md5Pass, $eventServiceURL;
  //Single Event
  $event_info = "<events>
     <event>
        <eventID>$eventID</eventID>
        <registeredEventDate>$eventDate $eventTime</registeredEventDate>
    </event>
  </events>";
  /*
  //Un-comment this to register multiple users 
  //Multiple Events
  $event_info = "<events>
     <event>
        <eventID>513304</eventID>
        <registeredEventDate>2011-05-26 09:00:00</registeredEventDate>
     </event>
     <event>
        <eventID>533360</eventID>
        <registeredEventDate>2011-05-21 23:00:00</registeredEventDate>
     </event>
     <event>
        <eventID>753292</eventID>
        <registeredEventDate>2011-05-30 09:00:00</registeredEventDate>
     </event>
  </events>";
  */
  //Single Registrant
  $registrant_info = "<registrants>
     <registrant>
        <firstName>Joe</firstName>
        <lastName>Martin</lastName>
        <email>test1@omnovia.com</email>
        <questions>
           <question>
              <id>43683</id>
              <answer>Male</answer>
           </question>
           <question>
              <id>43685</id>
              <answer>First Time</answer>
           </question>
        </questions>
      </registrant>
    </registrants>";
   /*
   //Multiple Registrants
   $registrant_info = "<registrants>
      <registrant>
         <firstName>Bill</firstName>
         <lastName>Smith</lastName>
         <email>bsmith@company.com</email>
         <questions>
            <question>
               <id>19471</id>
               <answer>male</answer>
            </question>
            <question>
               <id>19540</id>
               <answer>Trader</answer>
            </question>
         </questions>
      </registrant>
      <registrant>
         <firstName>Sandra</firstName>
         <lastName>Perez</lastName>
         <email>sperez@company.com</email>
         <questions>
            <question>
               <id>19471</id>
               <answer>female</answer>
            </question>
            <question>
               <id>19540</id>
               <answer>Investor</answer>
            </question>
         </questions>
      </registrant>
   </registrants>";
   */
   $params = array(
   'companyID' => $companyID,
   'md5pass' => $md5Pass,
   'eventInfo' => $event_info,
   'registrantInfo' => $registrant_info,
   'sendEmail' => 1,
   'custom' => '',
   /*'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,

   'invoiceNumber' => 'inv' . rand(1, 9999),
   'totalTax' => 0.49,
   'CC_Custom' => "$eventID|$eventDate|$eventTime|How to accept payments for your events",
   */
   //    'CC_UserName' => 'AAAAA',
   //    'CC_Password' => 'BBBBB',
   //    'CC_Signature' => 'CCCCC',
   'dummy' => 0
);
$url = $eventServiceURL . "/groupEventRegister";
echo callRemote($url, $params);
}

Sample Output:

<status>
<eventID><![CDATA[80856]]></eventID>
<eventName><![CDATA[Event Name]]></eventName>
<status><![CDATA[Updated]]></status>
<registeredEventDate><![CDATA[2011-06-03 10:00]]></registeredEventDate>
<timeZone><![CDATA[US/Central]]></timeZone>
<inviteeID><![CDATA[10673306]]></inviteeID>
<eventGMTTime><![CDATA[1307113200]]></eventGMTTime>
</status>

Get Event Custom Questions

Using this call you will be able to retrieve the custom questions. The event questions are only valid for one particlar event, and the company questions are valid for all the event.

URL Call:

http://www.omnovia.com/api/event/save

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(num) eventID

Sample Code:

      
    
function getCustomQuestions($eventID, $type) 
//type = company | event | both
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass,
    );

    $url = $eventServiceURL . "/questions/$eventID/$type";

    echo callRemote($url, $params);
}

Sample Output:

<question>
<questionID><![CDATA[20898]]></questionID>
<eventID><![CDATA[0]]></eventID>
<companyID><![CDATA[181]]></companyID>
<question><![CDATA[Test Text Box Company Wide]]></question>
<questionType><![CDATA[1]]></questionType>
<displayOrder><![CDATA[1]]></displayOrder>
<required><![CDATA[1]]></required>
</question>
<question>
<questionID><![CDATA[43683]]></questionID>
<eventID><![CDATA[80856]]></eventID>
<companyID><![CDATA[0]]></companyID>
<question><![CDATA[What is your gender]]></question>
<questionType><![CDATA[5]]></questionType>
<displayOrder><![CDATA[1]]></displayOrder>
<required><![CDATA[0]]></required>
<option><![CDATA[male]]></option>
<option><![CDATA[female]]></option>
</question>
<question>
<questionID><![CDATA[43685]]></questionID>
<eventID><![CDATA[80856]]></eventID>
<companyID><![CDATA[0]]></companyID>
<question><![CDATA[What is your position]]></question>
<questionType><![CDATA[5]]></questionType>
<displayOrder><![CDATA[2]]></displayOrder>
<required><![CDATA[0]]></required>
<option><![CDATA[Trader]]></option>
<option><![CDATA[Investor]]></option>
<option><![CDATA[other]]></option>
</question>

Insert Registrant

This method registers an invitee for a specified event.

URL Call:

http://www.omnovia.com/api/event/eventregister

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(str) email
(str) firstName
(str) lastName
(xml) eventInfo
(str) sendEmail
(str) custom

Sample Code:

function insertRegistrant($eventID, $eventDate, $eventTime)
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $event_info = "
    <events>
      <event>
        <eventID>$eventID</eventID>
        <registeredEventDate>$eventDate $eventTime</registeredEventDate>
      </event>
    </events>  
    ";
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass,
    'email' => 'email@address.com',
    'firstName' => 'First',
    'lastName' => 'Last',
    'eventInfo' => $event_info,
    'sendEmail' => 1,
    'custom' => ''
    );

    $url = $eventServiceURL . "/eventregister";

    echo callRemote($url, $params);
}

insertRegistrant(12345, "2010-02-28", "16:00:00");

Sample Output:

<events>
  <event>
    <eventID>12345</eventID>
    <registeredEventDate>2010-02-28 16:00:00</registeredEventDate>
  </event>
</events>

Insert Registrant with Credit Card Payment

This method registers an invitee for a specified paid event, and processes the payment using a credit card. Your company must be setup to accept credit card payments for events. Please contact our sales department to activate the credit card module.

URL Call:

http://www.omnovia.com/api/event/eventregister

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(str) email
(str) firstName
(str) lastName
(XML) eventInfo (See sample code below)
(num) sendEmail (0 | default: 1)
(str) ccFirstName
(str) ccLastName
(str) ccType ('Visa' | MasterCard' | 'Discover' | 'American Express')
(str) ccNumber
(str) ccExpDateMonth (mm)
(str) ccExpDateYear (yyyy)
(str) ccCVV2Number
(str) ccAddress1
(str) ccCity 
(str) ccState
(str) ccZip
(str) ccCountry
(float) amountToPay

Optional:
(str) custom  (Any custom message you want to add to the registration)

The following parameters are passed to PayPal for reporting purposes:
(float) totalTax
(str 127) invoiceNumber
(str 256) CC_Custom (Any custom message you want to pass to PayPal) 

You can optionally pass a set of PayPal credentials different to the one saved under your company
preferences by using the three parameters below. For example: You can test a transaction
using your sandbox credentials without having to change the Environment setting in the Event Manager.
(str) CC_UserName
(str) CC_Password
(str)CC_Signature

Sample Code:

function insertRegistrantWithCC($eventID, $eventDate, $eventTime)
{
 global $companyID, $md5Pass, $eventServiceURL;
 
 $event_info = "
<events>
 <event>
 <eventID>$eventID</eventID>
 <registeredEventDate>$eventDate $eventTime</registeredEventDate>
 </event>
 </events>
";

 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass,
 'email' => 'email@address.com',
 'firstName' => 'First',
 'lastName' => 'Last',
 'eventInfo' => $event_info,
 'sendEmail' => 1,
 'ccFirstName' => 'Joe',
 'ccLastName' => 'Martin',
 'ccType' => 'Visa',
 'ccNumber' => '4200123456789000',
 'ccExpDateMonth'=> 12,
 'ccExpDateYear' => 2019,
 'ccCVV2Number' => 135,
 'ccAddress1' => '1 Main St',
 'ccCity' => 'San Jose',
 'ccState' => 'CA',
 'ccZip' => '95131',
 'ccCountry' => 'US',
 'amountToPay' => 49.99,
 'custom' => ' This is an example of a paid event ',    
 'totalTax' => 0.49,
 'invoiceNumber' => 'inv-8547',
 'CC_Custom' => "$eventID|$eventDate|$eventTime|How to accept payments for your events ",
 'CC_UserName' => 'my_test_username',
 'CC_Password' => 'my_test_password',
 'CC_Signature' => 'my_test_signature'
 );

 $url = $eventServiceURL . "/eventregister";

 echo callRemote($url, $params);
}
insertRegistrantWithCC(12345, "2010-03-26", "09:00:00");

Sample Output:

Successful transaction:
<status>
 <eventID><![CDATA[12345]]></eventID>
 <eventName><![CDATA[How to accept payments for your events]]></eventName>
 <status><![CDATA[Added]]></status>
 <registeredEventDate><![CDATA[2010-03-26 09:00]]></registeredEventDate>
 <timeZone><![CDATA[US/Central]]></timeZone>
 <inviteeID><![CDATA[8704593]]></inviteeID>
 <eventGMTTime><![CDATA[1262017800]]></eventGMTTime>
 <TIMESTAMP><![CDATA[2010-03-26T15:00:00Z]]></TIMESTAMP>
 <CORRELATIONID><![CDATA[fb96fd2a9b061]]></CORRELATIONID>
 <ACK><![CDATA[Success]]></ACK>
 <VERSION><![CDATA[51.0]]></VERSION>
 <BUILD><![CDATA[1073465]]></BUILD>
 <AMT><![CDATA[49.99]]></AMT>
 <CURRENCYCODE><![CDATA[USD]]></CURRENCYCODE>
 <AVSCODE><![CDATA[X]]></AVSCODE>
 <CVV2MATCH><![CDATA[M]]></CVV2MATCH>
 <TRANSACTIONID><![CDATA[1GR75113HK623402F]]></TRANSACTIONID>
 <failure_contact><![CDATA[info@company.com]]></failure_contact>
</status>

Failed transaction (Invalid credit card number):
<status>
 <TIMESTAMP><![CDATA[2010-03-26T15:53:04Z]]></TIMESTAMP>
 <CORRELATIONID><![CDATA[c2790cbda58]]></CORRELATIONID>
 <ACK><![CDATA[Failure]]></ACK>
 <VERSION><![CDATA[51.0]]></VERSION>
 <BUILD><![CDATA[1073465]]></BUILD>
 <L_ERRORCODE0><![CDATA[10527]]></L_ERRORCODE0>
 <L_SHORTMESSAGE0><![CDATA[Invalid Data]]></L_SHORTMESSAGE0>
 <L_LONGMESSAGE0><![CDATA[This transaction cannot be processed. 
 Please enter a valid credit card number and type.]]></L_LONGMESSAGE0>
 <L_SEVERITYCODE0><![CDATA[Error]]></L_SEVERITYCODE0>
 <AMT><![CDATA[49.99]]></AMT>
 <CURRENCYCODE><![CDATA[USD]]></CURRENCYCODE>
 <failure_contact><![CDATA[info@company.com]]></failure_contact>
 <status><![CDATA[ccfailed]]></status>
</status>


Company not setup to accept payments (Contact our sales department to activate the credit card module):
<status>
 <status><![CDATA[error]]></status>
 <message><![CDATA[Company is not setup to accept payments for events]]></message>
</status>

Manual Send Email

This method allows you to send manually any of the reminders or follow up emails to the registered users or to a single user if you pass the email parameter.

URL Call:

http://www.omnovia.com/api/event/manualsend/{eventID}/{type}/{email}

Input Parameters:

URL Parameters:
Required:
(num) eventID: Internal ID of the event. The eventID can be retrieved from the Event List function.
(str) type:  ('reminder1' | 'reminder2' | 'followup')
Optional:
(str) email:  email address if sending to a single user instead of registered users

POST Parameters:
Required:
(str) companyID
(str) md5Pass
Optional:
(str) email_subject
(str) email_text
(str) email_html
(str) followup_type ('all' | 'attended' | 'not_attended')

Sample Code:

function manualSendEmail($eventID, $type, $email = '') 
{ 
 global $companyID, $md5Pass, $eventServiceURL; 
 
 $params = array( 
 'companyID' => $companyID, 
 'md5pass' => $md5Pass, 
 'email_subject' => "Test email", 
 'email_text' => "This is a test email."     
 ); 
 
 $url = $eventServiceURL . "/manualsend/$eventID/$type/$email"; 
 
 echo callRemote($url, $params); 
} 
 
manualSendEmail(12345, "reminder1", "email@address.com");

Sample Output:

<status>
    <send>complete</send>
</status>

Promotion Info

Use this method to get the details of a promotion code.

URL Call:

http://www.omnovia.com/api/event/promotioninfo

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(str) code

Sample Code:

function getPromotionInfo($code)
{
    global $companyID, $md5Pass, $eventServiceURL;
    
    $params = array(
    'companyID' => $companyID,
    'md5pass' => $md5Pass,
    'code' => $code
    );

    $url = $eventServiceURL . "/promotioninfo/";

    echo callRemote($url, $params);
}

getPromotionInfo("promo10off")

Sample Output:

Valid promotion code:
<promotion>
  <code><![CDATA[promo10off]]></code>
  <discountAmount><![CDATA[10.00]]></discountAmount>
  <discountRate><![CDATA[0.00]]></discountRate>
  <type><![CDATA[Amount]]></type>
</promotion>

Invalid promotion code:
<status>
  <error><![CDATA[no results found]]></error>
</status>

Refund Payment

This method allows you to refund the payment for an event.

URL Call:

http://www.omnovia.com/api/event/issueRefund

Input Parameters:

POST Parameters:
Required:
(str) companyID
(str) md5Pass
(str) transactionID
(str) refundType ('Full' | 'Partial')
(str) currencyID
(float) refundAmount

Sample Code:

function refundPayment($transactionID, $refundType, $currencyID, $refundAmount)
{
 global $companyID, $md5Pass, $eventServiceURL;
 
 $params = array(
 'companyID' => $companyID,
 'md5pass' => $md5Pass,
 'transactionID' => $transactionID,
 'refundType' => $refundType,
 'currencyID' => $currencyID,
 'refundAmount' => $refundAmount
 );

 $url = $eventServiceURL . "/issueRefund/";

 echo callRemote($url, $params);
}

Sample Output:

<status>
    <REFUNDTRANSACTIONID><![CDATA[45975190BK487031S]]></REFUNDTRANSACTIONID>
    <FEEREFUNDAMT><![CDATA[0.93]]></FEEREFUNDAMT>
    <GROSSREFUNDAMT><![CDATA[20.00]]></GROSSREFUNDAMT>
    <NETREFUNDAMT><![CDATA[19.07]]></NETREFUNDAMT>
    <CURRENCYCODE><![CDATA[USD]]></CURRENCYCODE>
    <TIMESTAMP><![CDATA[2010-05-05T19:25:27Z]]></TIMESTAMP>
    <CORRELATIONID><![CDATA[b40e5e15498f7]]></CORRELATIONID>
    <ACK><![CDATA[Success]]></ACK>
    <VERSION><![CDATA[51.0]]></VERSION>
    <BUILD><![CDATA[1288906]]></BUILD>
</status>

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.abcd.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>