Loading ...

REST API: Get Event Resource | Communifire Documentation

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

REST API: Get Event Resource

0 
 /5
0 (0votes)

Get Event Resource

GET /api/events/resources/{ResourceID}

Get an event resource. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
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.
ResourceID Used in the request URL as a path parameter

Unique ID of the event resource.

Example Request

GET https://myintranet.communifire.com/api/events/resources/5

Example Response

Event resource JSON is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "ResourceID": 5,
    "ResourceName": "Conference Room A",
    "Location": "Office Building A",
    "Description": "Place for large meetings",
    "EventResourceTypeID": 1,
    "Type": {
      "EventResourceTypeID": 1,
      "ResourceKey": "RoomText",
      "IsRoom": true,
      "TenantID": 0
    },
    "ImageFilename": "59eed55a-34fc-4337-a936-90f90d847d47.jpg",
    "SpaceIDCSV": "205,206,207",
    "DateCreated": "0001-01-01T00:00:00",
    "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