Loading ...

REST API: Get Event Resource Types | Communifire Documentation

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

REST API: Get Event Resource Types

0 
 /5
0 (0votes)

Get Event Resource Types

GET /api/events/resourcetypes

Get a list of event resource types along with their resources. 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.
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter Set a space ID to only include event resources which can be used in the space.
ResourceTypeID &ResourceTypeID=x - Used in the request URL as a query parameter Unique ID of the event resource type to return.

Example Request

GET https://myintranet.communifire.com/api/events/resourcetypes?SpaceID=252

Example Response

Event resource type JSON is returned as ResponseData.

[
   {
      "EventResourceTypeID": 1,
      "ResourceKey": "RoomText",
      "TypeName": "Room",
      "Translations": [
         {
            "ResourceKey": "RoomText",
            "ResourceValue": "Room",
            "CultureName": "en-US",
            "TenantID": 0
         }
      ],
      "IsRoom": true,
      "EventResources": [
         {
            "ResourceID": 5,
            "ResourceName": "Conference Room A",
            "Location": "Office Building A",
            "Description": "Place for large meetings",
            "EventResourceTypeID": 1,
            "CalendarURL": "/events/resources/5/calendar",
            "ImageFilename": "59eed55a-34fc-4337-a936-90f90d847d47.jpg",
            "ImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/59eed55a-34fc-4337-a936-90f90d847d47.jpg",
            "SpaceIDCSV": "252,257,258",
            "DateCreated": "0001-01-01T00:00:00",
            "TenantID": 1
         },
         {
            "ResourceID": 9,
            "ResourceName": "Conference Room B",
            "Location": "Office Building A",
            "Description": "Place for large meetings",
            "EventResourceTypeID": 1,
            "CalendarURL": "/events/resources/9/calendar",
            "ImageFilename": "814162a1-f98a-44ac-8810-bf9f7b53062d.jpg",
            "ImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/814162a1-f98a-44ac-8810-bf9f7b53062d.jpg",
            "SpaceIDCSV": "252,257,258",
            "DateCreated": "0001-01-01T00:00:00",
            "TenantID": 1
         }
      ],
      "TenantID": 0
   },
   {
      "EventResourceTypeID": 10,
      "ResourceKey": "CarsText",
      "Translations": [
         {
            "ResourceKey": "CarsText",
            "ResourceValue": "Cars",
            "CultureName": "en-US",
            "TenantID": 0
         }
      ],
      "IsRoom": false,
      "EventResources": [
         {
            "ResourceID": 10,
            "ResourceName": "Lincoln Navigator",
            "Location": "San Diego, CA",
            "Description": "The Lincoln Navigator is a big car.",
            "EventResourceTypeID": 10,
            "CalendarURL": "/events/resources/10/calendar",
            "ImageFilename": "ea77ac26-1fc3-425e-9452-10a0d7bf9fab.jpg",
            "ImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/ea77ac26-1fc3-425e-9452-10a0d7bf9fab.jpg",
            "SpaceIDCSV": "252,257,258",
            "DateCreated": "0001-01-01T00:00:00",
            "TenantID": 1
         }
      ],
      "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