Loading ...

REST API: Create Event Resource | Communifire Documentation

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

REST API: Create Event Resource

0 
 /5
0 (0votes)

Create Event Resource

POST /api/events/resources

Create a new event resource. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 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.
ResourceName Used in the request body Name of the event resource.
Location Used in the request body Description of the event resource.
Description Used in the request body Location of the event resource.
Optional Parameters How to use Description
EventResourceTypeID Used in the request body Unique ID of the event resource type for the event resource.
SpaceIDCSV Used in the request body Comma-separated list of spaces that can use the event resource.

Example Request

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

Body:

{
  "ResourceName": "Conference Room A",
  "Location": "Office Building A",
  "Description": "Place for large meetings",
  "EventResourceTypeID": 1,
  "SpaceIDCSV": "205,206,207"
}

Example Response

Event resource JSON is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": {
      "ResourceID": 12,
      "ResourceName": "Conference Room A",
      "Location": "Office Building A",
      "Description": "Place for large meetings",
      "EventResourceTypeID": 1,
      "CalendarURL": "/events/resources/12/calendar",
      "SpaceIDCSV": "205,206,207",
      "DateCreated": "2020-07-08T19:21:42.6733391Z",
      "TenantID": 1
   }
}

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

Wiki Index

Pages

Intranet Software