GET api/Events/WebEvents/{startDate}/{endDate}/{getEmailTemplate}/{getDependencies}/{loadImages}/{personID}

Gets a list of what's on items to display what up coming events are set-up for the site.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

Used to state the starting available date range for the web events to be returned.

 date

Required
endDate

Used to state the ending available date range for the web events to be returned.

 date

Required
getEmailTemplate

Used to state if the email template for the event should be returned.

 boolean

Default value is False
getDependencies

Used to state if the event dependencies for the event should be returned.

 boolean

Default value is False
loadImages

Used to state if the event images for the event should be returned.

 boolean

Default value is False
personID

Used to state what the person ID is for event business rules checking.

 integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
[{"EventID":0,"EventName":"","EventDescription":"","ActiveStartDate":"0001-01-01T00:00:00","ActiveEndDate":"0001-01-01T00:00:00","ResourceViewID":0,"ProductMapID":0,"PercentBuffer":0.0,"MinAdultsRequired":0,"Dependencies":[{"ID":0,"MainWebEventID":0,"DependentWebEventID":0}],"ProcessFlows":[{"Order":0,"Process":""}],"EmailTemplate":"","LargeImage":"","SmallImage":""}]

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<APIWhatsOnItemList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIWhatsOnItem>
    <EventID>0</EventID>
    <EventName />
    <EventDescription />
    <ActiveStartDate>0001-01-01T00:00:00</ActiveStartDate>
    <ActiveEndDate>0001-01-01T00:00:00</ActiveEndDate>
    <ResourceViewID>0</ResourceViewID>
    <ProductMapID>0</ProductMapID>
    <PercentBuffer>0</PercentBuffer>
    <MinAdultsRequired>0</MinAdultsRequired>
    <Dependencies>
      <Dependency>
        <ID>0</ID>
        <MainWebEventID>0</MainWebEventID>
        <DependentWebEventID>0</DependentWebEventID>
      </Dependency>
    </Dependencies>
    <ProcessFlows>
      <ProcessFlow>
        <Order>0</Order>
        <Process />
      </ProcessFlow>
    </ProcessFlows>
    <EmailTemplate />
    <LargeImage />
    <SmallImage />
  </APIWhatsOnItem>
</APIWhatsOnItemList>