GET api/Resources/ResourceListByDate/{resourceID}/{startDate}/{endDate}/{showProductMap}

Gets a list of resources based on a date range and can also return a specific resource if the resource ID is passed.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
resourceID

Used to specify a resource to be returned, if set to 0 then it will return all resources.

integer

Required

startDate

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

date

Required

endDate

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

date

Required

showProductMap

Used to state if the resources should contain their products or not.

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:
[{"ID":0,"Name":"","Date":"0001-01-01T00:00:00","StartTime":"","EndTime":"","AvailableFrom":"0001-01-01T00:00:00","AvailableTo":"0001-01-01T00:00:00","ResourceType":"","Adults":0,"Children":0,"Capacity":0,"TotalBooked":0,"ProductMapID":0,"AvailableDays":"","Notes":"","UpSellInfo":"","ProductList":[],"ResourceUDFs":null,"QuestionnaireID":0,"ReservedSpaces":0}]

application/xml, text/xml

Sample:
<?xml version="1.0" encoding="utf-16"?>
<Resources xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIResource>
    <ID>0</ID>
    <Name />
    <Date>0001-01-01T00:00:00</Date>
    <StartTime />
    <EndTime />
    <AvailableFrom>0001-01-01T00:00:00</AvailableFrom>
    <AvailableTo>0001-01-01T00:00:00</AvailableTo>
    <ResourceType />
    <Adults>0</Adults>
    <Children>0</Children>
    <Capacity>0</Capacity>
    <TotalBooked>0</TotalBooked>
    <ProductMapID>0</ProductMapID>
    <AvailableDays />
    <Notes />
    <UpSellInfo />
    <ProductList />
    <QuestionnaireID>0</QuestionnaireID>
    <ReservedSpaces>0</ReservedSpaces>
  </APIResource>
</Resources>