Loading ...

REST API: Get Event Resource Types | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Event Resources » REST API: Get Event Resource Types
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Get Event Resource Types

0 
 /5
0 (0votes)
Open API Guide
GET/api/events/resourcetypes

Enables administrators and developers to programmatically retrieve a list of event resource types along with their resources.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerNOQuerySet a space ID to only include event resources which can be used in the space
ResourceTypeIDIntegerNOQueryUnique ID of the event resource type to return

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/resourcetypes?SpaceID=252

Success Response

[
  {
    "EventResourceTypeID": 1,
    "ResourceKey": "RoomText",
    "TypeName": "Room",
    "Translations": [
      {
        "ResourceKey": "RoomText",
        "ResourceValue": "Room",
        "CultureName": "en-US"
      }
    ],
    "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://your-site.com/Assets/Uploaded-CMS-Files/59eed55a-34fc-4337-a936-90f90d847d47.jpg",
        "SpaceIDCSV": "252,257,258",
        "DateCreated": "0001-01-01T00:00:00"
      },
      {
        "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://your-site.com/Assets/Uploaded-CMS-Files/814162a1-f98a-44ac-8810-bf9f7b53062d.jpg",
        "SpaceIDCSV": "252,257,258",
        "DateCreated": "0001-01-01T00:00:00"
      }
    ]
  },
  {
    "EventResourceTypeID": 10,
    "ResourceKey": "CarsText",
    "Translations": [
      {
        "ResourceKey": "CarsText",
        "ResourceValue": "Cars",
        "CultureName": "en-US"
      }
    ],
    "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://your-site.com/Assets/Uploaded-CMS-Files/ea77ac26-1fc3-425e-9452-10a0d7bf9fab.jpg",
        "SpaceIDCSV": "252,257,258",
        "DateCreated": "0001-01-01T00:00:00"
      }
    ]
  }
]

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid.Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
200 with IsErrorThe caller cannot read events anywhere on the site (No permission).Call with a token that can read events.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages