GET Event?SystemAPIKey={SystemAPIKey}&SiteAPIKey={SiteAPIKey}&ExternalID={ExternalID}
Gets specific event
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 |
ExternalID |
Your system identifier for the event |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
GetEventResponseName | Description | Type | Additional information |
---|---|---|---|
Event |
Full event details excluding tracks requested. use api/EventTracks to retrieve tracks. |
Event |
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:
{ "Event": { "ExternalID": "sample string 1", "Site": { "ExternalID": "sample string 1", "Name": "sample string 2", "Type": "sample string 3" }, "Location": { "ExternalID": "sample string 1", "Name": "sample string 2", "TrackEmailAddress": "sample string 3" }, "Organiser": { "ExternalID": "sample string 1", "Name": "sample string 2", "CompanyName": "sample string 3", "Phone": "sample string 4", "Email": "sample string 5" }, "DateTime": "2024-12-28T13:51:07.5823462+00:00", "AllowDoubleBooking": true, "Description": "sample string 4", "WesleyEventNo": 1 }, "Successful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<GetEventResponse 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> <Event> <AllowDoubleBooking>true</AllowDoubleBooking> <DateTime>2024-12-28T13:51:07.5823462+00:00</DateTime> <Description>sample string 4</Description> <ExternalID>sample string 1</ExternalID> <Location> <ExternalID>sample string 1</ExternalID> <Name>sample string 2</Name> <TrackEmailAddress>sample string 3</TrackEmailAddress> </Location> <Organiser> <CompanyName>sample string 3</CompanyName> <Email>sample string 5</Email> <ExternalID>sample string 1</ExternalID> <Name>sample string 2</Name> <Phone>sample string 4</Phone> </Organiser> <Site> <ExternalID>sample string 1</ExternalID> <Name>sample string 2</Name> <Type>sample string 3</Type> </Site> <WesleyEventNo>1</WesleyEventNo> </Event> </GetEventResponse>