GET api/Resources/ResourceListByViewByDateByPerson/{viewName}/{startDate}/{endDate}/{personID}/{showProductMap}
Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability and takes in person ID for custom product discounts.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
viewName |
The view name for the list of resources to be returned. |
string |
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 |
personID |
Used to state the ID of the person to check for product discounts. |
integer |
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
HttpResponseMessageName | Description | Type | Additional 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}]
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> </APIResource> </Resources>