Loading ...

REST API: Get Event Resources | Communifire Documentation

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

REST API: Get Event Resources

0 
 /5
0 (0votes)

Get Event Resources

GET /api/events/resources

Get a list of event 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
ResourceTypeID &ResourceTypeID=x - Used in the request URL as a query parameter Unique ID of the resource type to filter by.
Keyword &Keyword=x - Used in the request URL as a query parameter Search term to filter results by.
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET: https://myintranet.communifire.com/api/events/resources?Keyword=conference&StartPage=1&PageLength=10

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
      },
      "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": "25,104,151",
      "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,
      "Type": {
        "EventResourceTypeID": 1,
        "ResourceKey": "RoomText",
        "IsRoom": true,
        "TenantID": 0
      },
      "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": "",
      "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