POST api/v1.0/Events/SearchEvents?maxRecords={maxRecords}

Get Event details. The retrieved Events can be filtered by the values passed in the eventFilter parameter.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
maxRecords

Specify the maximum number of records to return. Defaults to 100 if not specified.

integer

Default value is 100

Body Parameters

Allows filtering of the Events that are returned.

CalendarEventRequest
NameDescriptionTypeAdditional information
StartDate

date

None.

EndDate

date

None.

EventTypeName

string

None.

CommunityKey

globally unique identifier

None.

SearchKeywords

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDate": "2024-04-12T10:08:35.2383357Z",
  "EndDate": "2024-04-12T10:08:35.2383357Z",
  "EventTypeName": "sample string 3",
  "CommunityKey": "2772e918-9603-4770-a086-55588d97cceb",
  "SearchKeywords": "sample string 5"
}

application/xml, text/xml

Sample:
<CalendarEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
  <CommunityKey>2772e918-9603-4770-a086-55588d97cceb</CommunityKey>
  <EndDate>2024-04-12T06:08:35.2383357-04:00</EndDate>
  <EventTypeName>sample string 3</EventTypeName>
  <SearchKeywords>sample string 5</SearchKeywords>
  <StartDate>2024-04-12T06:08:35.2383357-04:00</StartDate>
</CalendarEventRequest>

Response Information

Resource Description

List of Events.

Collection of Event
NameDescriptionTypeAdditional information
RegistrationOptions

Collection of EventOption

None.

Sessions

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.