RHP_API

<back to all web services

GetEventSummaryCount

Returns a list of locations, and counts, that have current events.

Requires Authentication
The following routes are available for this service:
GET/Event/Count/
GetEventSummaryCount Parameters:
NameParameterData TypeRequiredDescription
GoogleMapPlaceIDquerystringNoThe GoogleMapPlaceID that represents a Country. If no GoogleMapPlaceID is supplied then a list of countries (with counts) will be returned.
IsIncludeGlobalEventsqueryboolNo

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 /Event/Count/ HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		GoogleMapPlaceID: String,
		Count: 0,
		Value: 0,
		Text: String,
		TextAbbr: String
	}
]