GET api/v1.0/Events/GetUpcoming?maxRecords={maxRecords}
Returns all Current (beginning today) and Future Events.
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
None.
Response Information
Resource Description
List of Events.
Collection of Event| Name | 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:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.