GET api/Events/EventDatesByViewName/{viewName}/{startDate}/{endDate}/{showProducts}

Gets a list of events within a date range, can be filtered by a view name for a group of events, it can also show the event products if specified.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
viewName

The view name for the list of event details to be returned.

 string

Required
startDate

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

 date

Required
endDate

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

 date

Required
showProducts

Used to state if the products should be returned with the events.

 boolean

Default value is False

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: 
[{"EventResourceID":0,"EventCode":0,"EventName":"","EventDescription":"","EventDate":"0001-01-01T00:00:00","EventStartTime":"","EventEndTime":"","EventNotes":"","EventQuestionnaireID":0,"ValidFrom":"0001-01-01T00:00:00","ValidTo":"0001-01-01T00:00:00","Capacity":0,"ProductMapID":0,"Adults":0,"Children":0,"TotalBooked":0,"ReservedSpaces":0,"ProductList":[{"ID":0,"PLU":"","ProductDescription":"","TicketDescription":"","GiftAidProduct":false,"GiftAidPortion":0.0,"Adults":0,"Children":0,"CategoryCode":0,"CategoryName":"","SubCategory":"","Department":"","PriceDescription":"","Price":0.0,"OnHand":0.0,"ProductImage":"","Notes":"","IsKit":false,"LowestKitItemPLU":"","Quantity":0,"SeatReservationID":0,"GiftVoucherReference":"","Donation":false,"ProductUDFs":null,"TicketCapacity":0,"TicketAvailability":0,"Barcode":"","Diminishing":true,"Discontinued":false,"InActive":false,"StockInUse":true}],"EventUDFs":null}]

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<EventList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIEvent>
    <EventResourceID>0</EventResourceID>
    <EventCode>0</EventCode>
    <EventName />
    <EventDescription />
    <EventDate>0001-01-01T00:00:00</EventDate>
    <EventStartTime />
    <EventEndTime />
    <EventNotes />
    <EventQuestionnaireID>0</EventQuestionnaireID>
    <ValidFrom>0001-01-01T00:00:00</ValidFrom>
    <ValidTo>0001-01-01T00:00:00</ValidTo>
    <Capacity>0</Capacity>
    <ProductMapID>0</ProductMapID>
    <Adults>0</Adults>
    <Children>0</Children>
    <TotalBooked>0</TotalBooked>
    <ReservedSpaces>0</ReservedSpaces>
    <ProductList>
      <APIProduct>
        <ID>0</ID>
        <PLU />
        <ProductDescription />
        <TicketDescription />
        <GiftAidProduct>false</GiftAidProduct>
        <GiftAidPortion>0</GiftAidPortion>
        <Adults>0</Adults>
        <Children>0</Children>
        <CategoryCode>0</CategoryCode>
        <CategoryName />
        <SubCategory />
        <Department />
        <PriceDescription />
        <Price>0</Price>
        <OnHand>0</OnHand>
        <ProductImage />
        <Notes />
        <IsKit>false</IsKit>
        <LowestKitItemPLU />
        <Quantity>0</Quantity>
        <SeatReservationID>0</SeatReservationID>
        <GiftVoucherReference />
        <Donation>false</Donation>
        <TicketCapacity>0</TicketCapacity>
        <TicketAvailability>0</TicketAvailability>
        <Barcode />
        <Diminishing>true</Diminishing>
        <Discontinued>false</Discontinued>
        <InActive>false</InActive>
        <StockInUse>true</StockInUse>
      </APIProduct>
    </ProductList>
  </APIEvent>
</EventList>