Loading ...

REST API: Event Overview | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Event Overview
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 13

REST API: Event Overview

0 
 /5
0 (0votes)

Event Properties

The event object is used to create events in the Communifire system. It includes the Event ID that is used to make reference to the particular event throughout the system. Each Event ID is unique and automatically generated by the Communifire system.

Attributes Notes Data type
Address Address of event. string
AlbumID Album ID of event. int
AttendanceID Unique ID of event attendance. int
AttendanceTypeID ID of attendance type.
  • Attending = 1
  • MaybeAttending = 2
  • NotAttending = 3
  • All = 4
  • AwaitingResponse = 5
 int
AttendeeCount Number of attendees for event. int
AvatarPath URL of the author's profile image. string
CommentCount Number of comments made on event. int
CountryName Country name in the event location. string
CreatedOnDate The date of event creation. datetime
DateTimeSpan Time spanned since the event was created. string
DayInterval Specifies the daily repeat interval of event. int
DayOfMonth A particular day of a month used for 'Monthly' frequency type. int
DaysOfMonth If the repeat interval is set to monthly, this field specifies the number of days of month after which the event repeats. int
DaysOfWeek If the repeat interval is set to monthly, this field specifies the number of days of week after which the event repeats. int
DaysOfWeekOptions Days of week options. 
  • Sun = 1
  • Mon = 2
  • Tue = 4
  • Wed = 8
  • Thu = 16
  • Fri = 32
  • Sat = 64
 DayOfWeekEnum
Description The description of event. string
EditEventURL URL to edit the event. string
EndAfterOccurences Specifies the number of occurrences after which the event will end. int
EndDate Event end date. datetime
EndDateISO Event end date in ISO format. string
EndDateText Event end date in text format. string
EndDateWithRespectToUser Event end date with respect to the current user. datetime
EndTimeText Event end time in text format. string
EntryDate Entry date for the attendees. datetime
EventBookedByUserDisplayName User display name of user who booked the event. string
EventBookedByUserID ID of user who booked the event. int
EventBookedByUserProfileURL User profile URL of user who booked the event. string
EventID ID value which uniquely identifies each event in the Communifire. Generated automatically. This cannot be changed. int
EventStatusID ID to identify the status of event.
  • PendingWorkflow = 0
  • Published = 1
  • Draft = 2
  • Declined = 3
  • Spam = 6
  • All = 7
 int
EventTypeID ID to identify the event type. int
EventTypeName Name of event type. string
EventURL URL to directly browse to the event. string
FirstName Author's first name. string
FrequencyTypeOptions The repeat frequency type. 
  • None = 0
  • Daily = 1
  • Weekly = 2
  • Monthly = 4
  • Quarterly = 8
  • Yearly = 16
  • EveryWeekDay = 32
  • EveryMonWedFri = 64
  • EveryTuTh = 128
 FrequencyTypeEnum
ImageURL URL of event featured image. string
IsAllDay Specifies if the event is an all-day event. bool
IsFeatured Specifies if the event is featured. bool
IsOnline Specifies if the event is online. bool
IsPrivate Specifies if the event is private. bool
IsRepeat Specifies if the event is to be repeated. bool
IsScheduled Specifies if the event is scheduled. bool
Keywords Keywords for the event. string
LastName Author's last name. string
Location Event location. string
MayBeAttendeeCount Count of the members who may be attending the event. int
MediaServerID ID of the media server on which the event is created. int
MetroName Metro city name in event location. string
MonthInterval Specifies the monthly repeat interval of event. int
MonthRepeatBy Monthly repeat options.
  • RepeatByDayOfMonth = 1
  • RepeatByDayOfWeek = 2
 MonthRepeatByEnum
MonthlyInterval If the repeat interval is set to yearly, this field specifies the number of months after which the event repeats. int
MonthlyIntervalOptions Monthly interval options.
  • First = 1
  • Second = 2
  • Third = 4
  • Fourth = 8
  • Last = 16
  • EveryWeek = 31
 MonthlyIntervalEnum
Organization Organization of creator of event. string
QuarterInterval Specifies the quarterly repeat interval of event. int
QuarterlyInterval If the repeat interval is set to yearly, this field specifies the number of quarters after which the event repeats. int
QuarterlyIntervalOptions Quarterly interval options.
  • First = 1
  • Second = 2
  • Last = 4
 QuarterlyIntervalEnum
QuarterlyOptions Quarterly options.
  • First = 1
  • Second = 2
  • Third = 4
  • Fourth = 8
 QuarterEnum
RangeEndMonth Ending month of the event duration range. int
RangeStartMonth Starting month of the event duration range. int
Rating Rating of event. double
RepeatEndDate End date of event repeat. datetime
RepeatEndDateISO End date of event repeat in ISO format. string
RepeatEndDateWithRespectToUser End date of event repeat with respect to user. datetime
RepeatStartDate Start date of event repeat. datetime
RepeatStartDateISO Start date of event repeat in ISO format. string
RepeatStartDateWithRespectToUser Start date of event repeat with respect to user. datetime
RepeatSummary Summary of the event repeat options selected. string
SpaceID Unique ID of space. int
SpaceName Name of space. string
StartDate Event start date. datetime
StartDateISO Event start date in ISO format. string
StartDateText Event start date in text format. string
StartDateWithRespectToUser Event start date with respect to user. datetime
StartTimeText Event start time in text format. string
StateName State name in event location. string
TagIDCSV ID value which uniquely identifies tags in the Communifire.
Generated automatically, This cannot be changed.		 string 
Telephone Telephone number of the event author. string
Title Title of the event. string
UpdatedByUserID ID of user who updated the event. int
UserAvatarFullUrl URL of the user's avatar image. string
UserDisplayName Display name of the user. string
UserEmail Email of the user who created the event. string
UserID ID of the user who created the event. int
UserName Username of the user who created the event. string
UserProfileURL URL of the user's profile who created the event. string
VenueName Name of the event venue. string
Views Number of views of the event. int
Website Website of creator of event. string
WeeklyInterval Specifies the weekly repeat interval of event. int
When The duration of the event. string
WhoShouldAttend Specifies what type of people should attend the event. string
WorkFlowID ID of the active workflow for event. int
YearInterval Specifies the yearly repeat interval of event. int
Zip Zip code of event's address. string

Please Note Refer to REST API: Create Event for how to create a new event via the REST API.

 

Wiki Index

Pages

Intranet Software