Get Event List

get
[PlatformAddress]/api/1.0/event?action=getEventList
getEventList
Additional Filter Properties
Property
Description
Type
afterDate
Filter by start date
​iVvy Timestamp Format​
beforeDate
Filter by end date
​iVvy Timestamp Format​
status
Filter by status Array of the following values
Must be an array
Returns
A collection object with the following properties in the results.
Property
Description
id
The unique event identifier
code
The code for the event
eventType
​The type of event.​
title
The title of the event
domainName
The domain name of the event
startDateTime
The start of the event, at UTC
endDateTime
The end of the event, at UTC
numRegistered
The number of registrations
currentStatus
​The current status of the event​
contactEmail
The contact email address on the event
websiteUrl
The URL for the event website
websiteTemplateBannerImageUrl
Banner that is displayed on the website
venue
​Details of the venue of the event (if the includeVenueDetails flag is set on the request)​
tickets
​The tickets of an event (if the includeTicketDetails flag is set on the request)​
information
​Event website information (if the includeInformationDetails flag is set on the request) This is an array of objects with the information properties.
homepageContent
Content of the website home page (if the includeHomepageContent flag is set on the request). Note this is the contents of the HTML that is entered in as the home page content of the event.
eventTags
​The tags of the event.​
modifiedDate
timestamp
The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties.
Event types
Type
Description
0
Other
1
Party
2
Festival
3
Golf Day
4
Wedding
5
Meeting
6
Seminar
7
Conference
8
Exhibition
9
Roadshow
10
Simple
11
Party (21st / 18th)
12
Record Event Details
The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties.
Current status of event
Code
Description
0
Draft
1
Closed
3
Launched
Venue details
Property
Description
name
The venue name
description
The description of the venue
address
The address of the venue
imageUrl
The URL to the image of the venue
Event ticket details
Property
Description
id
The unique identifier for the ticket
title
Title of the ticket
capacity
Capacity of the ticket
description
Description of the ticket
amount
Amount of the ticket
isTaxFree
Amount of the ticket is tax free
subscriptionGroups
​Subscription groups assigned to the ticket This an array of objects with subscription group properties.
Subscription group details
Property
Description
id
The subscription group identifier
groupName
The name for the group
tagColour
The designated colour for the group
Event website information details
Property
Description
description
Description of the information
information
Content of the information
fileUrl
Attached file url of event information
sortOrder
The order in which to sort the information
Event tags
Property
Description
id
The unique identifier for the event tag
name
The name of the event tag

Property	Description	Type
afterDate	Filter by start date	iVvy Timestamp Format
beforeDate	Filter by end date	iVvy Timestamp Format
status	Filter by status Array of the following values	Must be an array

Property	Description
id	The unique event identifier
code	The code for the event
eventType	The type of event.
title	The title of the event
domainName	The domain name of the event
startDateTime	The start of the event, at UTC
endDateTime	The end of the event, at UTC
numRegistered	The number of registrations
currentStatus	The current status of the event
contactEmail	The contact email address on the event
websiteUrl	The URL for the event website
websiteTemplateBannerImageUrl	Banner that is displayed on the website
venue	Details of the venue of the event (if the includeVenueDetails flag is set on the request)
tickets	The tickets of an event (if the includeTicketDetails flag is set on the request)
information	Event website information (if the includeInformationDetails flag is set on the request) This is an array of objects with the information properties.
homepageContent	Content of the website home page (if the includeHomepageContent flag is set on the request). Note this is the contents of the HTML that is entered in as the home page content of the event.
eventTags	The tags of the event.
modifiedDate	timestamp

Type	Description
0	Other
1	Party
2	Festival
3	Golf Day
4	Wedding
5	Meeting
6	Seminar
7	Conference
8	Exhibition
9	Roadshow
10	Simple
11	Party (21st / 18th)
12	Record Event Details

Code	Description
0	Draft
1	Closed
3	Launched

Property	Description
name	The venue name
description	The description of the venue
address	The address of the venue
imageUrl	The URL to the image of the venue

Property	Description
id	The unique identifier for the ticket
title	Title of the ticket
capacity	Capacity of the ticket
description	Description of the ticket
amount	Amount of the ticket
isTaxFree	Amount of the ticket is tax free
subscriptionGroups	Subscription groups assigned to the ticket This an array of objects with subscription group properties.

Property	Description
id	The subscription group identifier
groupName	The name for the group
tagColour	The designated colour for the group

Property	Description
description	Description of the information
information	Content of the information
fileUrl	Attached file url of event information
sortOrder	The order in which to sort the information

Property	Description
id	The unique identifier for the event tag
name	The name of the event tag

Add or Update Event

Get Event

Last modified 1yr ago