RHP_API

<back to all web services

GetClubEvents

Get list of events belong to the group/club.

Requires Authentication
The following routes are available for this service:
GET/Club/{ID}/Event
GetClubEvents Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
TypequeryEventSelectionTypeNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
GenericListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
DataformList<T>No
TotalformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Club/{ID}/Event HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			InterestCountGuest: 0,
			InterestCountUpgrade: 0,
			InterestCountTotal: 0,
			InterestCount: 0,
			HasExpressInterest: False,
			AgeRange: 
			{
				AgeFrom: 0,
				AgeTo: 0
			},
			GuestTypes: 
			[
				{
					IsMatch: False,
					Value: 0,
					Text: String,
					TextAbbr: String,
					ListID: 0
				}
			],
			IsSponsored: False,
			IsFeatured: False,
			EventID: 0,
			Title: String,
			DateHeld: 0001-01-01,
			DateHeldUtcIso: String,
			DateHeldDisplay: String,
			TimeZoneInfoID: String,
			TimeZone: 
			{
				ID: String,
				WindowsName: String,
				StandardName: String,
				DaylightName: String,
				SupportsDaylightSavingTime: False,
				IsDaylightSavingTime: False,
				IanaName: String,
				AbbrGeneric: String,
				AbbrStandard: String,
				AbbrDaylight: String,
				BaseUtcOffset: String,
				DaylightOffset: String
			},
			Categories: 
			[
				{
					IsMatch: False,
					Value: 0,
					Text: String,
					TextAbbr: String,
					ListID: 0
				}
			],
			OrganiserType: All,
			EventBannerUrl: String,
			EventFeaturedBannerUrl: String,
			EventGlobalBannerUrl: String,
			Location: 
			{
				City: String,
				State: String,
				StateAbbr: String,
				Country: String
			},
			IsFullGuestList: False,
			IsViewerOwner: False,
			ApprovalStatus: Approved,
			IsGroupChatAvailable: False,
			IsTicketUrlPrivate: False
		}
	],
	Total: 0
}