Home → Event Plugin → Printer Friendly Version
Event Plugin
- 1. API Calls
- 1.1. api/PluginCreateLoginToken - Check Email and Retrieve Login Token
- 1.2. api/PluginSubmitLoginToken - Submit Login Token
- 1.3. api/PluginContactInfoRetrieve - Retrieve Contact Information
- 1.4. api/PluginContactInfoUpdate - Update Contact Information
- 1.5. api/PluginCalendarDetail - Retrieve Detailed Information about the Event
- 1.6. api/PluginEventAttendees - Retrieve List of Attendees
- 1.7. api/PluginBookingStatusUpdate - Update a Booking's Status
- 1.8. api/PluginCreateBooking - Create and Confirm Booking
1. API Calls
1.1. api/PluginCreateLoginToken - Check Email and Retrieve Login Token
This API call is used to check if an email address is recognised/already associated with a contact record within the CRM.
If the email is found, you can use the returned login token with api/PluginSubmitLoginToken.
Parameters To Submit
The parameter cannot be submitted as a blank value.
| Parameter | Parameter Help | Parameter Data Type |
| emailaddress | Registering user’s email address. | String – Max 250 chars |
| API Key |
Return Response
The API call ResponseMessage will return the following fields of data.
| Field | Field Help |
| uid | The contact’s uid. |
| Company | The primary record/company the contact is associated with. |
| LoginVerified | True/False value indicating if the email address has been verified. |
| LoginTokenVal | This Val is required as part of api/PluginSubmitLoginToken. |
| LoginTokenID | This ID is required as part of api/PluginSubmitLoginToken. |
If 0 items are returned, the email address is not recognised.
1.2. api/PluginSubmitLoginToken - Submit Login Token
This API call is used to log in a user with a uid and a login token.
Parameters To Submit
All parameters are required and cannot be empty.
| Parameter | Parameter Help | Parameter Data Type |
| uid | Contact’s uid to be updated. | String – Max 50 chars |
| LoginTokenVal | Should be obtained as a querystring value on your page (sent as part of login token email) and denotes login token. This value is required and cannot be an empty string. | String |
| LoginTokenID | Should be obtained as a querystring value on your page (sent as part of login token email) and denotes whether the link is still active. This value is required and cannot be an empty string. | String |
| API Key |
Return Response
The API call ResponseMessage will return the following fields of data.
| Field | Field Help |
| uid | The contact’s uid. |
| EmailAddress | The contact’s email address. |
| FirstName | The contact’s first name. |
| LastName | The contact’s last name. |
| KnownAs | What the contact is known by. |
| Company | The primary record/company that the contact is associated with. |
| WebAdmin | Whether the contact is a website administrator. |
| UserStatus | The membership status of the company the contact is associated with. |
1.3. api/PluginContactInfoRetrieve - Retrieve Contact Information
This API call will return contact information.
The call requires you to pass the uid of the contact.
Parameters To Submit
| Parameter | Parameter Help | Parameter Data Type |
| uid | The contact's uid. | String – Max 50 chars |
| API Key |
Return Response
The API call will return the following fields of data.
| Field | Field Help |
| uid | Contact’s uid. |
| Title | Contact’s title. |
| FirstName | Contact’s first name. |
| LastName | Contact’s last name. |
| KnownAs | What the contact is known by. |
| EmailAddress | Contact’s email address. |
| JobTitle | Contact’s job title. |
| MobileCountry | Contact’s mobile country code. |
| Mobile | Contact’s mobile number. |
| TelCountry | Contact’s telephone country code. |
| Tel | Contact’s telephone number. |
| TelExt | Contact’s telephone extension number. |
| Address1 | First line of the contact’s address. |
| Address2 | Second line of the contact’s address. |
| Address3 | Third line of the contact’s address. |
| Address4 | Fourth line of the contact’s address. |
| County | County contact lives in. |
| Postcode | Contact’s postcode. |
| Country | Country contact lives in. |
| UserImage | URL of contact’s profile image. |
| MarketingPreferences | A JSON array of the contact’s marketing preferences (Contact Interests in Rubi). |
1.4. api/PluginContactInfoUpdate - Update Contact Information
This API call allows you to submit updates to contact information.
The call requires you to pass the uid of the contact and updatevalues.
Parameters To Submit
| Parameter | Parameter Help | Parameter Data Type |
| uid | The contact's uid. | String – Max 50 chars |
| updatevalues | JSONString stringified array of parameters. Review parameters below. | String |
| API Key |
updatevalues
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values. County and Country can be submitted as None.
| Parameter | Parameter Help | Parameter Data Type |
| Title | Contact’s title. | String – Max 20 chars |
| FirstName* | Contact’s first name. | String – Max 100 chars |
| LastName* | Contact’s last name. | String – Max 100 chars |
| KnownAs* | What the contact is known by. | String – Max 100 chars |
| EmailAddress* | Contact’s email address. | String – Max 200 chars |
| JobTitle* | Contact’s job title. | String – Max 200 chars |
| MobileCountry* | Contact’s mobile country code. | String – Max 5 chars |
| Mobile* | Contact’s mobile number. | String – Max 25 chars |
| TelCountry* | Contact’s telephone country code. | String – Max 5 chars |
| Tel* | Contact’s telephone number. | String – Max 30 chars |
| TelExt* | Contact’s telephone extension number. | String – Max 10 chars |
| Address1 | First line of the contact’s address if the contact has a personal address different to main Company/Organisation address. | String – Max 75 chars |
| Address2 | Second line of the contact’s address if the contact has a personal address different to main Company/Organisation address. | String – Max 75 chars |
| Address3 | Third line of the contact’s address if the contact has a personal address different to main Company/Organisation address. | String – Max 75 chars |
| Address4 | Fourth line of the contact’s address if the contact has a personal address different to main Company/Organisation address. | String – Max 75 chars |
| County* | County the contact resides if the contact has a personal address different to the main Company/Organisation address. (See api/PortalList with list “County” for available options) | String – Provide ListValue from api/PortalList “County” |
| Postcode | Postcode of contact’s address if the contact has a personal address different to the main Company/Organisation address. | String – Max 15 chars |
| Country* | County the contact resides if the contact has a personal address different to the main Company/Organisation address. (See api/PortalList with list “Country” for available options) | String – Provide ListValue from api/PortalList “Country” |
| MarketingPreferences | Stringified array of marketing interest preferences with "Marketing", "Email", "Mail" and "Tel" properties where "Email", "Mail" and "Tel" are true or false. | String |
This call returns a Boolean of True if successful.
1.5. api/PluginCalendarDetail - Retrieve Detailed Information about the Event
This API call will return details about a specific event. To retrieve details about a specific event you must pass in the eid acquired from api/Calendar or from within RubiCRM.
Parameters To Submit
Parameters can be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| uid | Logged in user’s uid. | String – Max 50 chars |
| eid | The event eid to return more information on. | String – Max 50 chars |
| API Key |
Return Response
The API call ResponseMessage will return the following fields of data.
| Field | Field Help |
| eid | Event GUID. |
| EventName | Event name. |
| EventStatus | Status of the event. |
| EventMonthYear | The integer value of the month and year of the event. |
| EventDay | Day of the event in shorthand string format. |
| EventDate | Date of the event in format dd/mm/yyyy. |
| EventStartTime | Event start time. |
| EventEndTime | Event end time. |
| EventDescription | The main body of text detailing the event. The field is named “Long Desc” in Rubi and is located on the event record’s “Details” page. |
| EventLocationOrganisation | Name of organisation the event is held (if applicable). |
| EventLocation1 | First line of the event address location. |
| EventLocation2 | Second line of the event address location. |
| EventLocation3 | Third line of the event address location. |
| EventLocation4 | Fourth line of the event address location. |
| EventLocationCounty | County of the event address location. |
| EventLocationPostcode | Postcode of the event address location. |
| EventLocationCountry | Country of the event address location. |
| EventTheme | Theme of the event. |
| EventType | Type of the event. |
| EventSponsor | JSON stringified array of sponsors. |
| EventPresenters | JSON stringified array of presenters. |
| BookOnline | Whether the event is bookable. This relates to the “Book Online” field set in Rubi under the “Web” section. |
| PriceCurrency | Currency code. |
| AllEventPrices | All prices set for the event. |
| ApplicableEventPrices | All applicable prices available to the logged in contact. |
| EventImage | Image URL set for the event. Field labelled “Event Image” in Rubi under the Web section. |
| MaxCompany | The maximum number of bookings allowed per company. Used to minimise company numbers for networking events. |
| MaxCompanyRemaining | The remaining number of bookings allowed for a company after taking into account active bookings and bookings awaiting payment. Provided a uid is supplied. |
| MaxRemaining | Total number of bookings available as a whole for the event. Takes into account active bookings. |
| CompanyActive | Returns the total number of active bookings for the company. Provided a uid is supplied. |
| CompanyWebAwaitingPayment | Returns the total number of bookings awaiting payment for the company. Provided a uid is supplied. |
| CanxPol | Cancellation policy for the event. Only to be used if the cancellation policy differs from the standard. If empty, then use the standard cancellation policy. |
| Agenda | Agenda for the event. The field named Agenda in RubiCRM is located on the event’s Details page. |
1.6. api/PluginEventAttendees - Retrieve List of Attendees
This API call is used to retrieve all attendees of an event/training course with their associated Booking Status based on the eid provided.
Parameters To Submit
All parameters are required and cannot be empty.
| Parameter | Parameter Help | Parameter Data Type |
| eid | The eid of the event to retrieve the list of attendees. | String – Max 50 chars |
| API Key |
Return Response
The API call ResponseMessage will return the following fields of data.
| Field | Field Help |
| bid | BookingGUID of the booking. |
| Attendeeuid | The uid of the contact marked as the attendee of the event/training course. |
| AttendeeFirstName | The attendee's first name or TBC if unknown. |
| AttendeeLastName | The attendee's last name or TBC if unknown. |
| AttendeeEmailAddress | The attendee's email address or TBC if unknown. |
| AttendeeJobTitle | The attendee's job title. |
| Bookeruid | The uid of the booker who made the booking of the event/training course. |
| BookerFirstName | The booker's first name. |
| BookerLastName | The booker's last name. |
| BookerEmailAddress | The booker's email address. |
| cid | The primary record's cid. |
| PrimaryRecord | The primary record the booking is associated with. |
| BookingStatus | The booking status of the booking. |
1.7. api/PluginBookingStatusUpdate - Update a Booking's Status
This API call allows you to update the Booking Status of a booking.
The call requires you to pass the bid of the booking and the BookingStatus.
Parameters To Submit
| Parameter | Parameter Help | Parameter Data Type |
| bid | The booking's BookingGUID. | String – Max 50 chars |
| BookingStatus | Available Booking Status option. (See api/PortalList with list “BookingStatus” for available options) | String – Provide ListValue from api/PortalList “BookingStatus” |
| API Key |
This call returns a Boolean of True if successful.
1.8. api/PluginCreateBooking - Create and Confirm Booking
This API call is used to create and confirm bookings in the CRM. It supports both free and paid bookings. For paid bookings, payment must be collected before submitting this request.
To complete the booking, you must provide the following parameters:
-
uid – The ID of the user who is logged in and making the booking.
-
eid – The ID of the event being booked.
-
EventPriceID – The specific pricing option being used for the booking.
-
AutoConfirmation – Indicates whether an automatic confirmation should be sent.
Before calling this endpoint, you must first check the api/PluginCalendarDetail to:
-
Confirm that BookOnline is set to true for the event.
-
Retrieve the available EventPriceID options that the specified uid is eligible to book.
Only proceed with the booking request once these conditions have been verified.
Parameters To Submit
| Parameter | Parameter Help | Parameter Data Type |
| uid | Contact's uid. | String – Max 50 chars |
| eid | The event eid being booked onto. | String – Max 50 chars |
| EventPriceID | The price ID used to book. Taken from api/PluginCalendarDetail. | Integer |
| AutoConfirmation | True/False: whether a confirmation email should be sent to the contact. | Boolean |
| API Key |
Return Response
This call returns a Boolean of True if successful.