GET api/Events/EventsList/{viewID}/{startDate}/{endDate}/{showDates}

Gets a list of event details within a date range which are assigned to a resource view, it can also show a list of available dates for the event.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
viewID

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

 integer

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
showDates

Used to state if the date list should be returned with the event details.

 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: 
[{"EventID":0,"EventCode":"","EventName":"","EventResource":"","Capacity":0,"ProductMapID":0,"AvailableDates":[]}]

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<EventDetailsList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIEventDetails>
    <EventID>0</EventID>
    <EventCode />
    <EventName />
    <EventResource />
    <Capacity>0</Capacity>
    <ProductMapID>0</ProductMapID>
    <AvailableDates />
  </APIEventDetails>
</EventDetailsList>