Loading ...

REST API: Get Events | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Get Events
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 19

REST API: Get Events

0 
 /5
0 (0votes)

Get Events

GET /api/events

Get a list of events. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
UserID &UserID=x - Used in the request URL as a query parameter ID of the user who created the event.
ShowSubscribedEvents &ShowSubscribedEvents= - Used in the request URL as a query parameter Set to true to return events RSVP'd as attending. If a UserID is specified, this method will return events which that user is attending.
Set to false to include events which you are not attending. Combine false with a UserID to get events created by that user.
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space from which the events are to be returned.
EntityStatus &EntityStatus=x - Used in the request URL as a query parameter Unique ID to identify the status of event:
  • PendingWorkflow = 0
  • Published = 1
  • Draft = 2
  • Declined = 3
  • Updated = 4
  • Expired = 5
  • Spam = 6
  • All = 7
  • DelayedPublishing = 8
IsFeatured &IsFeatured=x - Used in the request URL as a query parameter Used to get events marked as "featured".
EventType &EventType=x - Used in the request URL as a query parameter Unique ID to identify the event type.
StartDate &StartDate=x - Used in the request URL as a query parameter The event start date.
EndDate &EndDate=x - Used in the request URL as a query parameter The event end date.
DateRange &DateRange=x - Used in the request URL as a query parameter Date range of events to return. See REST API: Event List Display Types .
VenueName &VenueName=x - Used in the request URL as a query parameter Name of the event venue.
Keywords &Keywords=x - Used in the request URL as a query parameter Keywords for the event.
Month &Month=x - Used in the request URL as a query parameter The calendar month (in integer) for which the events have to be fetched, i.e. all events on this month would be returned.
AttendanceType &AttendanceType=x - Used in the request URL as a query parameter RSVP for the event.
  • 1 = Attending
  • 2 = Maybe attending
  • 3 = Not attending
  • 4 = All
  • 5 = Awaiting response
ResourceID &ResourceID=x - Used in the request URL as a query parameter Unique ID of the event resource to filter results by. Use REST API: Get Event Resources to get event resource IDs.
City &City=x - Used in the request URL as a query parameter City to filter results by.
StateID &StateID=x - Used in the request URL as a query parameter Unique ID of the state to filter results by. Use REST API: Get States  to get state IDs.
CountryID &CountryID=x - Used in the request URL as a query parameter Unique ID of the country to filter results by. Use REST API: Get Countries to get country IDs
SortColumn &SortColumn=x - Used in the request URL as a query parameter Sort Column is enum specifying how the events are to be sorted.
SortOrder &SortOrder=x - Used in the request URL as a query parameter Sort Order is enum specifying the order of sorting.
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of event list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET
https://myintranet.communifire.com/api/events?UserID=1&SpaceID=0&EntityStatus=1&EventType=1&Month=1&SortColumn=1&SortOrder=1&StartPage=1&PageLength=100

Example Response

Event JSON objects are returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
    [
        {
            "EventID":180,
            "AlbumID":0,
            "IsPrivate":false,
            "IsScheduled":false,
            "MediaServerID":3,
            "CommentCount":2,
            "EventTypeID":1,
            "Title":"Workshop",
            "WorkFlowID":0,
            "Description":"<p>Workshop</p>",
            "DescriptionUnprocessed":"<p>Workshop</p>",
            "StartDate":"2015-12-15T05:45:00",
            "EndDate":"2015-12-25T05:45:00",
            "SpaceID":0,
            "Views":6,
            "IsFeatured":false,
            "Address":"",
            "Zip":"",
            "EventStatusID":1,
            "UserName":"John",
            "Telephone":"",
            "CreatedOnDate":"2015-12-15T05:56:09.99",
            "Organization":"",
            "WhoShouldAttend":"",
            "Website":"",
            "VenueName":"",
            "EventTypeName":"Conference",
            "AttendanceID":0,
            "AttendanceTypeID":0,
            "UserID":1,
            "EntryDate":"0001-01-01T00:00:00",
            "AvatarPath":"f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
            "IsOnline":false,
            "FirstName":"John",
            "LastName":"smith",
            "UserEmail":"acme@acme.com",
            "UserProfileURL":"http://myintranet.communifire.com/people/john",
            "UserDisplayName":"John smith",
            "UserAvatarFullUrl":"http://myintranet.communifire.com/Assets/Uploaded-Photos/f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
            "DateTimeSpan":"12/15/2015",
            "EventURL":"/events/details/180",
            "EditEventURL":"/myaccount/events/addedit?eventID=180",
            "StartDateText":"12/15/2015 11:15 AM",
            "EndDateText":"12/25/2015 11:15 AM",
            "UpdatedByUserID":0,
            "AttendeeCount":0,
            "MayBeAttendeeCount":0,
            "Rating":2.7199999999999998,
            "Location":"",
            "StartTimeText":"11:15 AM",
            "EndTimeText":"11:15 AM",
            "EventBookedByUserID":0,
            "IsAllDay":false,
            "StartDateISO":"2015-12-15T11:15:00.00Z",
            "EndDateISO":"2015-12-25T11:15:00.00Z",
            "DaysOfWeek":0,
            "IsRepeat":false,
            "QuarterInterval":0,
            "QuarterlyInterval":0,
            "MonthlyInterval":0,
            "WeeklyInterval":0,
            "DaysOfMonth":0,
            "FrequencyTypeOptions":0,
            "QuarterlyOptions":0,
            "QuarterlyIntervalOptions":0,
            "MonthlyIntervalOptions":0,
            "DaysOfWeekOptions":0,
            "RangeStartMonth":0,
            "RangeEndMonth":0,
            "RepeatStartDate":"2015-12-15T05:45:00",
            "RepeatStartDateISO":"2015-12-15T11:15:00.00Z",
            "EndAfterOccurences":0,
            "DayInterval":0,
            "MonthInterval":0,
            "DayOfMonth":0,
            "YearInterval":0,
            "StartDateWithRespectToUser":"2015-12-15T11:15:00",
            "EndDateWithRespectToUser":"2015-12-25T11:15:00",
            "RepeatStartDateWithRespectToUser":"2015-12-15T11:15:00",
            "RepeatEndDateWithRespectToUser":"0001-01-01T00:00:00",
            "When":"12/15/2015 11:15 AM - 12/25/2015 11:15 AM (India Standard Time)",
            "RepeatSummary":""
        },
        {
            "EventID":201,
            "AlbumID":0,
            "IsPrivate":false,
            "IsScheduled":false,
            "MediaServerID":3,
            "CommentCount":0,
            "EventTypeID":1,
            "Title":"Ready to work.",
            "WorkFlowID":0,
            "Description":"General discussion.",
            "DescriptionUnprocessed":"General discussion.",
            "StartDate":"2016-01-02T00:00:00",
            "EndDate":"2016-01-03T00:00:00",
            "SpaceID":0,
            "Views":0,
            "IsFeatured":false,
            "Address":"",
            "Zip":"",
            "EventStatusID":1,
            "UserName":"john",
            "Telephone":"",
            "CreatedOnDate":"2016-02-08T20:08:34.307",
            "Organization":"",
            "WhoShouldAttend":"",
            "Website":"",
            "VenueName":"",
            "EventTypeName":"Conference",
            "AttendanceID":0,
            "AttendanceTypeID":0,
            "UserID":1,
            "EntryDate":"0001-01-01T00:00:00",
            "AvatarPath":"f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
            "IsOnline":false,
            "FirstName":"John",
            "LastName":"Smith",
            "UserEmail":"acme@acme.com",
            "UserProfileURL":"http://myintranet.communifire.com/people/john",
            "UserDisplayName":"John smith",
            "UserAvatarFullUrl":"http://myintranet.communifire.com/Assets/Uploaded-Photos/f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
            "DateTimeSpan":"a minute ago",
            "EventURL":"/events/details/201",
            "EditEventURL":"/myaccount/events/addedit?eventID=201",
            "StartDateText":"1/2/2016 05:30 AM",
            "EndDateText":"1/3/2016 05:30 AM",
            "UpdatedByUserID":0,
            "AttendeeCount":0,
            "MayBeAttendeeCount":0,
            "Rating":0.0,
            "Location":"",
            "StartTimeText":"05:30 AM",
            "EndTimeText":"05:30 AM",
            "EventBookedByUserID":0,
            "IsAllDay":false,
            "StartDateISO":"2016-01-02T05:30:00.00Z",
            "EndDateISO":"2016-01-03T05:30:00.00Z",
            "DaysOfWeek":0,
            "IsRepeat":false,
            "QuarterInterval":0,
            "QuarterlyInterval":0,
            "MonthlyInterval":0,
            "WeeklyInterval":0,
            "DaysOfMonth":0,
            "FrequencyTypeOptions":0,
            "QuarterlyOptions":0,
            "QuarterlyIntervalOptions":0,
            "MonthlyIntervalOptions":0,
            "DaysOfWeekOptions":0,
            "RangeStartMonth":0,
            "RangeEndMonth":0,
            "RepeatStartDate":"2016-01-02T00:00:00",
            "RepeatStartDateISO":"2016-01-02T05:30:00.00Z",
            "EndAfterOccurences":0,
            "DayInterval":0,
            "MonthInterval":0,
            "DayOfMonth":0,
            "YearInterval":0,
            "StartDateWithRespectToUser":"2016-01-02T05:30:00",
            "EndDateWithRespectToUser":"2016-01-03T05:30:00",
            "RepeatStartDateWithRespectToUser":"2016-01-02T05:30:00",
            "RepeatEndDateWithRespectToUser":"0001-01-01T00:00:00",
            "When":"1/2/2016 05:30 AM - 1/3/2016 05:30 AM (India Standard Time)",
            "RepeatSummary":""
        },
        {
            "EventID":202,
            "AlbumID":0,
            "IsPrivate":false,
            "IsScheduled":false,
            "MediaServerID":3,
            "CommentCount":0,
            "EventTypeID":1,
            "Title":"Trip to chicago",
            "WorkFlowID":0,
            "Description":"Trip to chicago on monday.",
            "DescriptionUnprocessed":"Trip to chicago on monday.",
            "StartDate":"2016-01-02T00:00:00",
            "EndDate":"2016-01-03T00:00:00",
            "SpaceID":0,
            "Views":0,
            "IsFeatured":false,
            "Address":"",
            "Zip":"",
            "EventStatusID":1,
            "UserName":"john",
            "Telephone":"",
            "CreatedOnDate":"2016-02-08T20:09:53.737",
            "Organization":"",
            "WhoShouldAttend":"",
            "Website":"",
            "VenueName":"",
            "EventTypeName":"Conference",
            "AttendanceID":0,
            "AttendanceTypeID":0,
            "UserID":1,
            "EntryDate":"0001-01-01T00:00:00",
            "AvatarPath":"f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
            "IsOnline":false,
            "FirstName":"John",
            "LastName":"smith",
            "UserEmail":"acme@acme.com",
            "UserProfileURL":"http://myintranet.communifire.com/people/john",
            "UserDisplayName":"John smith",
            "UserAvatarFullUrl":"http://myintranet.communifire.com/Assets/Uploaded-Photos/f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
            "DateTimeSpan":"20 seconds ago",
            "EventURL":"/events/details/202",
            "EditEventURL":"/myaccount/events/addedit?eventID=202",
            "StartDateText":"1/2/2016 05:30 AM",
            "EndDateText":"1/3/2016 05:30 AM",
            "UpdatedByUserID":0,
            "AttendeeCount":0,
            "MayBeAttendeeCount":0,
            "Rating":0.0,
            "Location":"",
            "StartTimeText":"05:30 AM",
            "EndTimeText":"05:30 AM",
            "EventBookedByUserID":0,
            "IsAllDay":false,
            "StartDateISO":"2016-01-02T05:30:00.00Z",
            "EndDateISO":"2016-01-03T05:30:00.00Z",
            "DaysOfWeek":0,
            "IsRepeat":false,
            "QuarterInterval":0,
            "QuarterlyInterval":0,
            "MonthlyInterval":0,
            "WeeklyInterval":0,
            "DaysOfMonth":0,
            "FrequencyTypeOptions":0,
            "QuarterlyOptions":0,
            "QuarterlyIntervalOptions":0,
            "MonthlyIntervalOptions":0,
            "DaysOfWeekOptions":0,
            "RangeStartMonth":0,
            "RangeEndMonth":0,
            "RepeatStartDate":"2016-01-02T00:00:00",
            "RepeatStartDateISO":"2016-01-02T05:30:00.00Z",
            "EndAfterOccurences":0,
            "DayInterval":0,
            "MonthInterval":0,
            "DayOfMonth":0,
            "YearInterval":0,
            "StartDateWithRespectToUser":"2016-01-02T05:30:00",
            "EndDateWithRespectToUser":"2016-01-03T05:30:00",
            "RepeatStartDateWithRespectToUser":"2016-01-02T05:30:00",
            "RepeatEndDateWithRespectToUser":"0001-01-01T00:00:00",
            "When":"1/2/2016 05:30 AM - 1/3/2016 05:30 AM (India Standard Time)",
            "RepeatSummary":""
        }
    ]
}


Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software