Loading ...

REST API: Get Events By User ID | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Get Events By User ID
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 20

REST API: Get Events By User ID

0 
 /5
0 (0votes)

Get Events By User ID

GET /api/events/spaces/{SpaceID}

Get a list of space events and check a specific user's attendance status. 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.
SpaceID Used in the request URL as a path parameter Unique ID of space under which you are searching for events.
Optional Parameters How to use Description
UserID &UserID=x - Used in the request URL as a query parameter ID of the user to check attendance statuses for

Example Request

GET https://myintranet.communifire.com/api/events/spaces/252?UserID=376

Example Response

Event JSON objects are returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "CanBeViewed": true,
      "CanBeEdited": true,
      "CanBeDeleted": true,
      "IsBusy": true,
      "AttendanceType": 1,
      "IsShared": false,
      "CanInviteOthers": true,
      "InvitedByCRMContactID": 0,
      "EventID": 552,
      "AlbumID": 0,
      "IsPrivate": false,
      "IsScheduled": false,
      "IsEvent": false,
      "IsClassPeriod": false,
      "MediaServerID": 64,
      "MainImageFileName": "",
      "CommentCount": 0,
      "EventTypeID": 624,
      "Title": "Company Picnic",
      "WorkFlowID": 0,
      "CurrentWorkFlowStepID": 0,
      "SpaceName": "Human Resources",
      "SpaceURL": "/spaces/252/human-resources/hr-homepage",
      "Description": "<p>Come and join us!</p>",
      "DescriptionUnprocessed": "<p>Come and join us!</p>",
      "StartDate": "2020-11-21T19:00:00",
      "EndDate": "2020-11-21T23:00:00",
      "SpaceID": 252,
      "Views": 1,
      "IsFeatured": false,
      "IsPrivateSpace": false,
      "IsPublishedFromDraftMode": false,
      "Address": "",
      "Address2": "",
      "CountryID": 0,
      "Zip": "",
      "EventStatusID": 1,
      "UserName": "admin",
      "Telephone": "",
      "CreatedOnDate": "2020-11-18T19:02:48.453",
      "Organization": "",
      "Keywords": "",
      "WhoShouldAttend": "",
      "City": "",
      "Website": "",
      "VenueName": "Recreation Center",
      "EventTypeName": "Team Building",
      "AttendanceID": 0,
      "UserID": 376,
      "AvatarPath": "1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "IsOnline": false,
      "MetroID": 0,
      "FirstName": "Alexis",
      "LastName": "Fox",
      "UserEmail": "alexis.fox@axerosolutions.com",
      "StateID": 0,
      "UserProfileURL": "https://documentation.communifire.com/people/admin",
      "UserDisplayName": "Alexis Fox",
      "UserAvatarFullUrl": "https://documentation.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "DateTimeSpan": "6 days ago",
      "EventURL": "/spaces/252/human-resources/events/details/552",
      "EditEventURL": "/events/addedit?eventID=552&spaceid=252",
      "StartDateText": "11/21/2020 11:00 AM",
      "EndDateText": "11/21/2020 3:00 PM",
      "UpdatedByUserID": 0,
      "AttendeeCount": 1,
      "MayBeAttendeeCount": 0,
      "Rating": 0.0,
      "Location": "Recreation Center",
      "StartTimeText": "11:00 AM",
      "EndTimeText": "3:00 PM",
      "EventBookedByUserID": 0,
      "Tags": [],
      "Reminders": [
        {
          "ReminderID": 912,
          "EntityType": 5,
          "EntityID": 552,
          "ReminderType": 1,
          "ReminderTime": 30,
          "UserID": 376,
          "ReminderSent": true,
          "TenantID": 0
        },
        {
          "ReminderID": 913,
          "EntityType": 5,
          "EntityID": 552,
          "ReminderType": 1,
          "ReminderTime": 10,
          "UserID": 376,
          "ReminderSent": true,
          "TenantID": 0
        }
      ],
      "IsAllDay": false,
      "StartDateISO": "2020-11-21T11:00:00.00",
      "EndDateISO": "2020-11-21T15:00:00.00",
      "FrequencyChoice": 0,
      "Frequency": 0,
      "DaysOfWeek": 0,
      "IsRepeat": false,
      "QuarterInterval": 0,
      "QuarterlyInterval": 0,
      "MonthlyInterval": 0,
      "WeeklyInterval": 0,
      "DaysOfMonth": 0,
      "IsSundaySelected": false,
      "IsMondaySelected": false,
      "IsTuesdaySelected": false,
      "IsWednesdaySelected": false,
      "IsThursdaySelected": false,
      "IsFridaySelected": false,
      "IsSaturdaySelected": false,
      "IsFirstWeekOfMonthSelected": false,
      "IsSecondWeekOfMonthSelected": false,
      "IsThirdWeekOfMonthSelected": false,
      "IsFourthWeekOfMonthSelected": false,
      "IsLastWeekOfMonthSelected": false,
      "FrequencyTypeOption": 0,
      "QuarterlyOptions": 0,
      "QuarterlyIntervalOptions": 0,
      "MonthlyIntervalOptions": 0,
      "WeeklyIntervalOptions": 0,
      "DaysOfWeekOptions": 0,
      "RangeStartMonth": 0,
      "RangeEndMonth": 0,
      "RepeatStartDate": "2020-11-21T19:00:00",
      "RepeatStartDateISO": "2020-11-21T11:00:00.00",
      "EndAfterOccurences": 0,
      "DayInterval": 0,
      "MonthInterval": 0,
      "DayOfMonth": 0,
      "YearInterval": 0,
      "RepeatEndType": 1,
      "StartDateWithRespectToUser": "2020-11-21T11:00:00",
      "EndDateWithRespectToUser": "2020-11-21T15:00:00",
      "RepeatStartDateWithRespectToUser": "2020-11-21T11:00:00",
      "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
      "When": "11/21/2020 11:00 AM <i class=\"icon-long-arrow-right\"></i>  3:00 PM (Pacific Standard Time)",
      "RepeatSummary": "",
      "ResourceIDCSV": "",
      "TenantID": 0
    },
    {
      "CanBeViewed": true,
      "CanBeEdited": true,
      "CanBeDeleted": true,
      "IsBusy": true,
      "AttendanceType": 1,
      "IsShared": false,
      "CanInviteOthers": true,
      "InvitedByCRMContactID": 0,
      "EventID": 547,
      "AlbumID": 0,
      "IsPrivate": false,
      "IsScheduled": false,
      "IsEvent": false,
      "IsClassPeriod": false,
      "MediaServerID": 64,
      "MainImageFileName": "6deded1d-caa2-4d19-bcc9-bf1fd0ea23cf.jpg",
      "CommentCount": 0,
      "EventTypeID": 567,
      "Title": "Update Employee Directory",
      "WorkFlowID": 0,
      "CurrentWorkFlowStepID": 0,
      "SpaceName": "Human Resources",
      "SpaceURL": "/spaces/252/human-resources/hr-homepage",
      "Description": "",
      "DescriptionUnprocessed": "",
      "StartDate": "2020-09-30T21:00:00",
      "EndDate": "2020-09-30T21:00:00",
      "SpaceID": 252,
      "Views": 1,
      "IsFeatured": false,
      "IsPrivateSpace": false,
      "IsPublishedFromDraftMode": false,
      "Address": "",
      "Address2": "",
      "CountryID": 0,
      "Zip": "",
      "EventStatusID": 1,
      "UserName": "admin",
      "Telephone": "",
      "CreatedOnDate": "2020-09-11T18:49:00.2",
      "Organization": "",
      "Keywords": "",
      "WhoShouldAttend": "",
      "City": "",
      "Website": "",
      "VenueName": "",
      "EventTypeName": "Meeting",
      "AttendanceID": 0,
      "UserID": 376,
      "AvatarPath": "1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "IsOnline": false,
      "MetroID": 0,
      "FirstName": "Alexis",
      "LastName": "Fox",
      "UserEmail": "alexis.fox@axerosolutions.com",
      "StateID": 0,
      "UserProfileURL": "https://documentation.communifire.com/people/admin",
      "ImageURL": "https://documentation.communifire.com/Assets/Uploaded-CMS-Files/6deded1d-caa2-4d19-bcc9-bf1fd0ea23cf.jpg",
      "UserDisplayName": "Alexis Fox",
      "UserAvatarFullUrl": "https://documentation.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "DateTimeSpan": "9/11/2020",
      "EventURL": "/spaces/252/human-resources/events/details/547",
      "EditEventURL": "/events/addedit?eventID=547&spaceid=252",
      "StartDateText": "9/30/2020 2:00 PM",
      "EndDateText": "9/30/2020 2:00 PM",
      "UpdatedByUserID": 0,
      "AttendeeCount": 1,
      "MayBeAttendeeCount": 0,
      "Rating": 0.0,
      "Location": "Conference Room A",
      "StartTimeText": "2:00 PM",
      "EndTimeText": "2:00 PM",
      "EventBookedByUserID": 0,
      "Tags": [],
      "Reminders": [
        {
          "ReminderID": 892,
          "EntityType": 5,
          "EntityID": 547,
          "ReminderType": 1,
          "ReminderTime": 30,
          "UserID": 376,
          "ReminderSent": true,
          "TenantID": 0
        },
        {
          "ReminderID": 893,
          "EntityType": 5,
          "EntityID": 547,
          "ReminderType": 1,
          "ReminderTime": 10,
          "UserID": 376,
          "ReminderSent": true,
          "TenantID": 0
        }
      ],
      "IsAllDay": false,
      "StartDateISO": "2020-09-30T14:00:00.00",
      "EndDateISO": "2020-09-30T14:00:00.00",
      "FrequencyChoice": 0,
      "Frequency": 0,
      "DaysOfWeek": 0,
      "IsRepeat": false,
      "QuarterInterval": 0,
      "QuarterlyInterval": 0,
      "MonthlyInterval": 0,
      "WeeklyInterval": 0,
      "DaysOfMonth": 0,
      "IsSundaySelected": false,
      "IsMondaySelected": false,
      "IsTuesdaySelected": false,
      "IsWednesdaySelected": false,
      "IsThursdaySelected": false,
      "IsFridaySelected": false,
      "IsSaturdaySelected": false,
      "IsFirstWeekOfMonthSelected": false,
      "IsSecondWeekOfMonthSelected": false,
      "IsThirdWeekOfMonthSelected": false,
      "IsFourthWeekOfMonthSelected": false,
      "IsLastWeekOfMonthSelected": false,
      "FrequencyTypeOption": 0,
      "QuarterlyOptions": 0,
      "QuarterlyIntervalOptions": 0,
      "MonthlyIntervalOptions": 0,
      "WeeklyIntervalOptions": 0,
      "DaysOfWeekOptions": 0,
      "RangeStartMonth": 0,
      "RangeEndMonth": 0,
      "RepeatStartDate": "2020-09-30T21:00:00",
      "RepeatStartDateISO": "2020-09-30T14:00:00.00",
      "EndAfterOccurences": 0,
      "DayInterval": 0,
      "MonthInterval": 0,
      "DayOfMonth": 0,
      "YearInterval": 0,
      "RepeatEndType": 1,
      "StartDateWithRespectToUser": "2020-09-30T14:00:00",
      "EndDateWithRespectToUser": "2020-09-30T14:00:00",
      "RepeatStartDateWithRespectToUser": "2020-09-30T14:00:00",
      "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
      "When": "9/30/2020 2:00 PM <i class=\"icon-long-arrow-right\"></i>  2:00 PM (Pacific Daylight Time)",
      "RepeatSummary": "",
      "ResourceIDCSV": "5",
      "TenantID": 0
    }
  ]
}

 

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

Wiki Index

Pages

Intranet Software