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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfLocationCountSummaryItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <LocationCountSummaryItem>
    <Count>0</Count>
    <GoogleMapPlaceID>String</GoogleMapPlaceID>
    <Text>String</Text>
    <TextAbbr>String</TextAbbr>
    <Value>0</Value>
  </LocationCountSummaryItem>
</ArrayOfLocationCountSummaryItem>