GET EventSearch?SystemAPIKey={SystemAPIKey}&SiteAPIKey={SiteAPIKey}&SiteExternalID={SiteExternalID}&StartDate={StartDate}&EndDate={EndDate}

Returns a list of EventSearchResult between two dates (maximum one week)

Request Information

URI Parameters

Name	Description	Type	Additional information
SystemAPIKey	API Key provided by Wesley to identify your event management system	string	Required
SiteAPIKey	API Key specific to the site in which your event management system is being used	string	Required
SiteExternalID	Your system identifier for the site in which to find events	string	Required
StartDate	Start date and time e.g. 2019-04-20 08:00:00	date	Required
EndDate	End date and time e.g. 2019-04-21 23:59:59	date	Required

Body Parameters

None.

Response Information

Resource Description

EventSearchResponse

Name	Description	Type	Additional information
Events	List of objects containing basic event details and external identifiers, use get api/Event method to return full details for an event	Collection of EventSearchResult	None.
Successful	False = API Call failed, True = API was called successfully and data passed validation	boolean	None.
ErrorMessage	Contains the description of the error e.g. Invalid API Key	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Events": [
    {
      "ExternalID": "sample string 1",
      "EventDateTime": "2024-12-28T13:57:55.1369009+00:00",
      "AllowDoubleBooking": true,
      "Description": "sample string 4",
      "SiteExternalID": "sample string 5",
      "LocationExternalID": "sample string 6",
      "OrganiserExternalID": "sample string 7",
      "WesleyEventNo": 1
    },
    {
      "ExternalID": "sample string 1",
      "EventDateTime": "2024-12-28T13:57:55.1369009+00:00",
      "AllowDoubleBooking": true,
      "Description": "sample string 4",
      "SiteExternalID": "sample string 5",
      "LocationExternalID": "sample string 6",
      "OrganiserExternalID": "sample string 7",
      "WesleyEventNo": 1
    }
  ],
  "Successful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<EventSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WesleyAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Successful>true</Successful>
  <Events>
    <EventSearchResult>
      <AllowDoubleBooking>true</AllowDoubleBooking>
      <Description>sample string 4</Description>
      <EventDateTime>2024-12-28T13:57:55.1369009+00:00</EventDateTime>
      <ExternalID>sample string 1</ExternalID>
      <LocationExternalID>sample string 6</LocationExternalID>
      <OrganiserExternalID>sample string 7</OrganiserExternalID>
      <SiteExternalID>sample string 5</SiteExternalID>
      <WesleyEventNo>1</WesleyEventNo>
    </EventSearchResult>
    <EventSearchResult>
      <AllowDoubleBooking>true</AllowDoubleBooking>
      <Description>sample string 4</Description>
      <EventDateTime>2024-12-28T13:57:55.1369009+00:00</EventDateTime>
      <ExternalID>sample string 1</ExternalID>
      <LocationExternalID>sample string 6</LocationExternalID>
      <OrganiserExternalID>sample string 7</OrganiserExternalID>
      <SiteExternalID>sample string 5</SiteExternalID>
      <WesleyEventNo>1</WesleyEventNo>
    </EventSearchResult>
  </Events>
</EventSearchResponse>