POST api/v2.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
Name | Description | Type | Additional 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.
CalendarEventRequestName | Description | Type | Additional information |
---|---|---|---|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
EventTypeName | string |
None. |
|
CommunityKey | globally unique identifier |
None. |
|
SearchKeywords | string |
None. |
Request Formats
application/json, text/json
{ "StartDate": "2024-09-07T15:57:40.7225544Z", "EndDate": "2024-09-07T15:57:40.7225544Z", "EventTypeName": "sample string 3", "CommunityKey": "79ea7496-89e9-4e80-8fec-e4c9a75cbc22", "SearchKeywords": "sample string 5" }
application/xml, text/xml
<CalendarEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <CommunityKey>79ea7496-89e9-4e80-8fec-e4c9a75cbc22</CommunityKey> <EndDate>2024-09-07T11:57:40.7225544-04:00</EndDate> <EventTypeName>sample string 3</EventTypeName> <SearchKeywords>sample string 5</SearchKeywords> <StartDate>2024-09-07T11:57:40.7225544-04:00</StartDate> </CalendarEventRequest>
Response Information
Resource Description
List of Events.
Collection of EventName | Description | Type | Additional information |
---|---|---|---|
RegistrationOptions | Collection of EventOption |
None. |
|
Sessions | Collection of EventSession |
None. |
|
EventKey | globally unique identifier |
None. |
|
Address | Address |
None. |
|
ParticipationType | integer |
None. |
|
DialInInstructions | string |
None. |
|
EventURL | string |
None. |
|
LoginInstructions | string |
None. |
|
EventTitle | string |
None. |
|
ShortTitle | string |
None. |
|
EventTypeKey | globally unique identifier |
None. |
|
EventType | EventType |
None. |
|
CommunityKey | globally unique identifier |
None. |
|
Community | Community |
None. |
|
StartDateTime | date |
None. |
|
StartDateTimeUTC | date |
None. |
|
EndDateTime | date |
None. |
|
EndDateTimeUTC | date |
None. |
|
EndDateTimeCalculated | date |
None. |
|
ArchiveDateTime | date |
None. |
|
TimeZoneKey | globally unique identifier |
None. |
|
TimeZone | TimeZoneRef |
None. |
|
EventListDisplayType | integer |
None. |
|
SearchResultsDisplayType | integer |
None. |
|
ContactKey | globally unique identifier |
None. |
|
ContactFirstName | string |
None. |
|
ContactFirstLast | string |
None. |
|
ContactLastName | string |
None. |
|
ContactEmail | string |
None. |
|
ContactPhone | string |
None. |
|
EventDescription | string |
None. |
|
PictureFileName | string |
None. |
|
PictureUrl | string |
None. |
|
PictureHeight | integer |
None. |
|
PictureWidth | integer |
None. |
|
RegistrationProcessOption | integer |
None. |
|
RegRedirectURL | string |
None. |
|
CurrencyType | CurrencyType |
None. |
|
UseBadgeName | boolean |
None. |
|
UseDisabilityOrSpecial | boolean |
None. |
|
SpecialInstructions | boolean |
None. |
|
SpecialInstructionsLabelText | string |
None. |
|
EarlyRegistrationDate | date |
None. |
|
RegularRegistrationDate | date |
None. |
|
RegularRegistrationEndDate | date |
None. |
|
LateRegistrationEndDate | date |
None. |
|
SuppressSessionDisplay | boolean |
None. |
|
ShowPriceDetails | boolean |
None. |
|
LegacyEventKey | string |
None. |
|
ConfirmationEmailText | string |
None. |
|
DetailURL | string |
None. |
|
EventTypeName | string |
None. |
|
FormatedDateRange | string |
None. |
|
FormatedDateRangeLong | string |
None. |
|
FormatedDateRangeLongMonth | string |
None. |
|
FormatedDateRangeYear | string |
None. |
|
HasPricing | boolean |
None. |
|
ICalendarData | string |
None. |
|
IsAcceptingRegistrations | boolean |
None. |
|
IsActive | boolean |
None. |
|
IsReadyForRegistration | boolean |
None. |
|
LinkToEventDetails | string |
None. |
|
MemberFee | decimal number |
None. |
|
NonMemberFee | decimal number |
None. |
|
RegistrantCount | integer |
None. |
|
RegThankyouMessage | string |
None. |
|
SuppressOptionDisplay | boolean |
None. |
|
UseForm | boolean |
None. |
|
CreatedByUser | string |
None. |
|
CreatedByUserKey | globally unique identifier |
None. |
|
CreatedOn | date |
None. |
|
UpdatedByUser | string |
None. |
|
UpdatedByUserKey | globally unique identifier |
None. |
|
UpdatedOn | date |
None. |
|
RequireAttendanceToVote | boolean |
None. |
|
AttendedInd | string |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.