You are here: RainWorx.FrameWorx.MVC Namespaces > RainWorx.FrameWorx.MVC.Controllers > RealTimeController Class > GetAllEvents Method

RealTimeControllerGetAllEvents Method

AuctionWorx 3.5 API
Retrieves a page of Events, excluding Deleted and Archived

Namespace:  RainWorx.FrameWorx.MVC.Controllers
Assembly:  RainWorx.FrameWorx.MVC (in RainWorx.FrameWorx.MVC.dll) Version: 3.5

Syntax

C#
public JsonResult GetAllEvents(
	int? page,
	int? pageSize,
	bool? excludeClosed
)

Parameters

page
Type: SystemNullableInt32
0-based page index
pageSize
Type: SystemNullableInt32
the maximum results to return
excludeClosed
Type: SystemNullableBoolean
optional parameter to limit results to active/preview events

Return Value

Type: JsonResult
JSON encoded result: { PageCount = n, Items = [ { EventID = n1, EventTitle = "x1", EndDTTM = "dttm1", Status = "y1" }, { EventID = n2, EventTitle = "x2", EndDTTM = "dttm2", Status = "y2" }, { ... } ] }
See Also

Reference

Copyright © 2002-2022. RainWorx Software. All rights reserved.