MenuClose

Events - API Reference

Select API:

Events

Events have a start/end date and additional information, they might be bookable, or just for informational purposes

End Point URL

https://api.cms-tool.net/webapps/api/event

API Parameters and Filters

Name Description Example Optional Data type
data The JSON you would like to POST. This can be POST content also
data =
{
"eventtitle" : "New Year Event",
"eventstartdate" : "2019-12-31"
}
 Yes json object
id Search a specific event id id=123 Yes int

eventtitle

 Search events by event title

eventtitle="New Year Event"

 Yes string

Data Dictionary

Key Definition Type Format

Usage Instructions and Examples

Create a new event

To create a new event use POST method and do not provide any Event Id. 

Example:

{

"eventtitle" : "New Year Event",

"eventsummary": "Summary of the event..",

"eventstartdate" : "2019-12-31",

"eventedndate" : "2020-01-01",

"page": 123

}

Update en existing event

You can also update an existing event's details. You must include an Event Id. The rest of the parameters provided will be used to update the event.

Example:

{ 
   "id":123,
   "eventtitle":"eventtitle" : "The event title has been changed" ...
}

Sample Object


{
"eventcapacity":9999,
"eventid":1234,
"eventattendeecnt":0,
"eventtakebookingsuntil":"00:00:01",
"eventendtime":"10:00:00",
"event_enquiry_form":"Always",
"eventpid":0,
"eventwebinarurl":"https://webinarurl.com",
"site_search_keywords":"^webinar",
"eventauthorid":0,
"eventenddate":"2021-11-10",
"eventtimestamp":"2021-09-14 11:52:00.0",
"eventtitle":"Webinar event",
"eventstartdate":"2021-11-10",
"parenteventid":0,
"event_privacy":0,
"id":1234,
"page":111,
"eventvenue":0,
"eventstarttime":"09:00:00",
"cid":222
}

API End Points

Content

Blog
Blog pages are usually presented as a list udner a primary page. Individual blog pages do not appear on the menu, only in lists. The blog engine also powers FAQ and gallery type pages
EndPoint: https://api.cms-tool.net/webapps/api/blog
Web Page
A website is made up of the primary navigational pages that create the primary menu, as well as hidden pages and member only pages. Pages can contain pages in a treelike structure, however, this excludes sub pages which are defined as blogs or products
EndPoint: https://api.cms-tool.net/webapps/api/page

Ecommerce

Categories
Categories are used to group products. Products can belong in up to 8 categories. Categories can also form a tree, with Category parent ID = 0 being the parent level category. The term group is synomous with category, so many elements are prefixed with the word group.
EndPoint: https://api.cms-tool.net/webapps/api/category
Discounts
Each product line of an order can be discounted, so an order can have multiple discounts, but only one per product.
EndPoint: https://api.cms-tool.net/webapps/api/discount
Payment Methods
The available payment methods at checkout. An order can only have 1 payment method, but the admin can change the payment method, and take part payments.
EndPoint: https://api.cms-tool.net/webapps/api/paymentop
Products
A saleable item, or variant of a parent product.
EndPoint: https://api.cms-tool.net/webapps/api/product
Sales Order
Invoices, orders, baskets and quotes are all represented by this object, and differentiated by status.
EndPoint: https://api.cms-tool.net/webapps/api/basket
Shipping Rules
The courier or freight fee rules available for checkout. Each order can only have rule applied
EndPoint: https://api.cms-tool.net/webapps/api/shipping

Members

Bulk Email
Bulk emails represent a newsletter that will be sent to a bulk audience via a mailing list. Alternatively, a bulk email is a sequence within a campaign.
EndPoint: https://api.cms-tool.net/webapps/api/bulkemail
Enquiries
A message is created for every contact us, enquiry form, or custom form.
EndPoint: https://api.cms-tool.net/webapps/api/message
Member Group
Group members/customers, each member can belong to unlimited groups. Groups can contain groups
EndPoint: https://api.cms-tool.net/webapps/api/membergroups
Member Level
System security levels. Default level is 100 for general users.
EndPoint: https://api.cms-tool.net/webapps/api/reference/memberlevel
Members / Customers
Members or customers or users are the same thing. These are anyone who has purchased, enquired, or who has permission to login, or receive newsletters. This excludes administrative users.
EndPoint: https://api.cms-tool.net/webapps/api/member
Reviews and Comments
A blog comment or product review uses the same engine. Each record may have a rating, as well as an optional comment, and is linked to an object and the person who posted it
EndPoint: https://api.cms-tool.net/webapps/api/comments

Other

Appointment Bookings
Bookings are for appointments, seats, hire items, etc. Not for events.
EndPoint: https://api.cms-tool.net/webapps/api/booking
Event Attendee
Use the Event Attendee endpoint to get your event attendee information on your site.
EndPoint: https://api.cms-tool.net/webapps/api/eventAttendee
Events
Events have a start/end date and additional information, they might be bookable, or just for informational purposes
EndPoint: https://api.cms-tool.net/webapps/api/event

Reference

Countries
A list of countries, and some meta data
EndPoint: https://api.cms-tool.net/webapps/api/reference/countries
Currencies
EndPoint: https://api.cms-tool.net/webapps/api/reference/currencies
Currency FX rates
EndPoint: https://api.cms-tool.net/webapps/api/reference/fx
Generic Categories
Generic categories are those that relate to open source categorisations of products for SEO purposes
EndPoint: https://api.cms-tool.net/webapps/api/reference/categories
Postcodes
EndPoint: https://api.cms-tool.net/webapps/api/reference/postcodes