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

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": "2021-09-25T18:22:10.0772503Z",
  "EndDate": "2021-09-25T18:22:10.0772503Z",
  "EventTypeName": "sample string 3",
  "CommunityKey": "1f24b8b9-0663-4b89-84e4-abd59a6c1f11",
  "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>1f24b8b9-0663-4b89-84e4-abd59a6c1f11</CommunityKey>
  <EndDate>2021-09-25T14:22:10.0772503-04:00</EndDate>
  <EventTypeName>sample string 3</EventTypeName>
  <SearchKeywords>sample string 5</SearchKeywords>
  <StartDate>2021-09-25T14:22:10.0772503-04:00</StartDate>
</CalendarEventRequest>

Response Information

Resource Description

List of Events.

Collection of Event
NameDescriptionTypeAdditional 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:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.