MyHome.ie Data Delivery Service

SearchFeaturedSpots

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
GET,POST	/featuredproducts/search

**SearchFeaturedSpots** Parameters:
Name	Parameter	Data Type	Required
GroupIds	body	List<int>	No
PropertyIds	body	List<int>	No
OrderId	body	int?	No
FeaturedSpotTypeIds	body	List<int>	No
LocalityIds	body	List<int>	No
StartDate	body	DateTime?	No
EndDate	body	DateTime?	No
PropertyClassIds	body	List<int>	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
CorrelationId	form	string	No
ActiveUserId	form	int?	No
Version	form	double	No
RequestTypeId	form	int	No

**GetFeaturedProductsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
FeaturedProducts	form	List<FeaturedSpot>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**BaseType** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	double	No

**FeaturedSpot** Parameters:
Name	Parameter	Data Type	Required
FeaturedSpotId	form	int	No
FeaturedSpotTypeId	form	int	No
ProductId	form	int	No
OrderId	form	int	No
GroupId	form	int	No
PropertyId	form	int?	No
StartDate	form	DateTime	No
EndDate	form	DateTime?	No
LocalityId	form	int?	No
PropertyClassId	form	int?	No
CreatedByUserId	form	int	No
CreatedOn	form	DateTime	No
ModifiedOn	form	DateTime	No
EventStartsOn	form	DateTime?	No
EventEndsOn	form	DateTime?	No
CustomJson	form	string	No
MinPrice	form	decimal?	No
MaxPrice	form	decimal?	No
MinBeds	form	short?	No
MaxBeds	form	short?	No
PropertyTypeId	form	int?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /featuredproducts/search HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SearchFeaturedSpots xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.FeaturedProduct">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">String</ApiKey>
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">String</CorrelationId>
  <ActiveUserId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</ActiveUserId>
  <Version xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</Version>
  <RequestTypeId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</RequestTypeId>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <FeaturedSpotTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </FeaturedSpotTypeIds>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </GroupIds>
  <LocalityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LocalityIds>
  <OrderId>0</OrderId>
  <PropertyClassIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PropertyClassIds>
  <PropertyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PropertyIds>
  <StartDate>0001-01-01T00:00:00</StartDate>
</SearchFeaturedSpots>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetFeaturedProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.FeaturedProduct">
  <Version xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</Version>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <FeaturedProducts xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.FeaturedProduct.Types">
    <d2p1:FeaturedSpot>
      <d2p1:CreatedByUserId>0</d2p1:CreatedByUserId>
      <d2p1:CreatedOn>0001-01-01T00:00:00</d2p1:CreatedOn>
      <d2p1:CustomJson>String</d2p1:CustomJson>
      <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
      <d2p1:EventEndsOn>0001-01-01T00:00:00</d2p1:EventEndsOn>
      <d2p1:EventStartsOn>0001-01-01T00:00:00</d2p1:EventStartsOn>
      <d2p1:FeaturedSpotId>0</d2p1:FeaturedSpotId>
      <d2p1:FeaturedSpotTypeId>0</d2p1:FeaturedSpotTypeId>
      <d2p1:GroupId>0</d2p1:GroupId>
      <d2p1:LocalityId>0</d2p1:LocalityId>
      <d2p1:MaxBeds>0</d2p1:MaxBeds>
      <d2p1:MaxPrice>0</d2p1:MaxPrice>
      <d2p1:MinBeds>0</d2p1:MinBeds>
      <d2p1:MinPrice>0</d2p1:MinPrice>
      <d2p1:ModifiedOn>0001-01-01T00:00:00</d2p1:ModifiedOn>
      <d2p1:OrderId>0</d2p1:OrderId>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:PropertyClassId>0</d2p1:PropertyClassId>
      <d2p1:PropertyId>0</d2p1:PropertyId>
      <d2p1:PropertyTypeId>0</d2p1:PropertyTypeId>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
    </d2p1:FeaturedSpot>
  </FeaturedProducts>
</GetFeaturedProductsResponse>