RHP_API

<back to all web services

GetUserClubEvents

Get all Club events

Requires Authentication
The following routes are available for this service:
GET/User/Club/{ClubID}/Event/
GetUserClubEvents Parameters:
NameParameterData TypeRequiredDescription
ClubIDpathintNo
TypequeryEventSelectionTypeNo
IsApprovedOnlyqueryboolNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo

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 /User/Club/{ClubID}/Event/ HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		EventID: 0,
		EventTitle: 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
		},
		ApprovalStatus: Approved,
		EventBannerUrl: String,
		InterestCount: 0,
		Location: 
		{
			City: String,
			State: String,
			StateAbbr: String,
			Country: String
		},
		EventType: MemberEvent
	}
]