Loading ...

REST API: Create Event | Communifire Documentation

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

REST API: Create Event

0 
 /5
0 (0votes)

Create Event

POST /api/events

Create a new event. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
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.
Event JSON Used in the request body This is JSON that represents an event object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
EventTypeID Used in the request body Unique ID to identify the event type.
Description Used in the request body The description of event. (Optional parameter from v6.0)
Title Used in the request body Title of the event.
StartDate Used in the request body The event start date.
EndDate Used in the request body The event end date.
Optional Parameters How to use Description
IsPrivate Used in the request body Specifies if the event is private.
SpaceID Used in the request body Unique ID of the space under which the event is to be created.
IsPrivateSpace Used in the request body Specifies if the event is private.
IsFeatured Used in the request body Used to mark a content as "featured".
Address Used in the request body Address where the event will take place.
MetroName Used in the request body Metro city name.
StateName Used in the request body State name.
Zip Used in the request body Zip code of event's address.
Telephone Used in the request body Telephone number of the event author.
Organization Used in the request body Organization of creator of event.
WhoShouldAttend Used in the request body Specifies what type of people should attend the event.
Website Used in the request body Website of creator of event.
VenueName Used in the request body Name of the event venue.
Location Used in the request body Location of the event.
IsAllDay Used in the request body Specifies if the event is an all-day event.
Optional Parameters for Recurring Events  How to use  Description
IsRepeat Used in the request body Specifies if the event is to be repeated.
IsOnline Used in the request body Specifies if the event is online.
VenueName Used in the request body Name of the event venue.
IsRepeat Used in the request body Boolean. Determines whether the event is a recurring event or not. Default: false
Frequency Used in the request body Integer. Frequency for repeating events. Possible values: 0: None,  1: Daily, 2: Weekly, 4: Monthly, 16: Yearly, 32: Every weekday (Monday to Friday), 64: Every Monday, Wednesday, and Friday, 128: Every Tuesday and Thursday128. Default: 0
DayInterval Used in the request body Integer. The days interval used for ‘Daily’ frequency type. E.g., every day, every 2 days, every 3 days, .... , every n days. Default: 1
WeeklyInterval Used in the request body Integer. The weeks interval used for ‘Weekly’ frequency type. E.g., every week, every 2 weeks, every 3 weeks, .... , every n weeks. Default 1
MonthInterval Used in the request body Integer: The months interval used for ‘Monthly’ frequency type. E.g., every month, every 2 months, every 3 months, .... , every n months. Default: 1
YearInterval Used in the request body Integer. The years interval used for ‘Yearly’ frequency type. E.g., every year, every 2 years, every 3 years, .... , every n years. Default 1
MonthRepeatBy Used in the request body Integer. Type of monthly repetition. Values: 1: - repeat by day of month, 2 - repeat by day of week. Default 1
DaysOfWeek Used in the request body Integer. The days of the week that the event occurs. Add the day values together. Sun = 1, Mon = 2, Tue = 4, Wed = 8, Thu = 16, Fri = 32, Sat = 64. Default: day of the week of the start date
DayOfMonth Used in the request body Integer. A particular day of a month used for ‘Monthly’ frequency type. E.g., 1st day of every month, 10th day of every 2 months, etc. Default: day of month of the start date

Example Request

POST https://myintranet.communifire.com/api/events

Body:

{
    "EventTypeID":1,
    "Description":"The Nobel Prize is a set of annual international awards bestowed in a number of categories by Swedish and Norwegian committees in recognition of academic, cultural and/or scientific advances.",
    "Title":"Nobel Prize",
    "StartDate":"2016-01-01T17:00:00",
    "EndDate":"2016-01-01T18:00:00"
}

Example Response

Event ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"ToBePublished",
    "ResponseData":2726
}

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

Wiki Index

Pages

Intranet Software